Package com.google.cloud.resourcemanager.v3

Class SearchFoldersRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.resourcemanager.v3.SearchFoldersRequest
All Implemented Interfaces:
SearchFoldersRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SearchFoldersRequest extends com.google.protobuf.GeneratedMessage implements SearchFoldersRequestOrBuilder
 The request message for searching folders.
Protobuf type google.cloud.resourcemanager.v3.SearchFoldersRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    SearchFoldersRequest.Builder
    The request message for searching folders.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    PAGE_SIZE_FIELD_NUMBER
     
    static final int
    PAGE_TOKEN_FIELD_NUMBER
     
    static final int
    QUERY_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static SearchFoldersRequest
    getDefaultInstance()
     
    SearchFoldersRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    int
    getPageSize()
    Optional.
    String
    getPageToken()
    Optional.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Optional.
    com.google.protobuf.Parser<SearchFoldersRequest>
    getParserForType()
     
    String
    getQuery()
    Optional.
    com.google.protobuf.ByteString
    getQueryBytes()
    Optional.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SearchFoldersRequest.Builder
    newBuilder()
     
    static SearchFoldersRequest.Builder
    newBuilder(SearchFoldersRequest prototype)
     
    SearchFoldersRequest.Builder
    newBuilderForType()
     
    protected SearchFoldersRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static SearchFoldersRequest
    parseDelimitedFrom(InputStream input)
     
    static SearchFoldersRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchFoldersRequest
    parseFrom(byte[] data)
     
    static SearchFoldersRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchFoldersRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static SearchFoldersRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchFoldersRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static SearchFoldersRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchFoldersRequest
    parseFrom(InputStream input)
     
    static SearchFoldersRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchFoldersRequest
    parseFrom(ByteBuffer data)
     
    static SearchFoldersRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SearchFoldersRequest>
    parser()
     
    SearchFoldersRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getPageSize

      public int getPageSize()
       Optional. The maximum number of folders to return in the response. The
 server can return fewer folders than requested. If unspecified, server
 picks an appropriate default.
      int32 page_size = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageSize in interface SearchFoldersRequestOrBuilder
      Returns:
      The pageSize.

    • getPageToken

      public String getPageToken()
       Optional. A pagination token returned from a previous call to
 `SearchFolders` that indicates from where search should continue.
      string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageToken in interface SearchFoldersRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       Optional. A pagination token returned from a previous call to
 `SearchFolders` that indicates from where search should continue.
      string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageTokenBytes in interface SearchFoldersRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • getQuery

      public String getQuery()
       Optional. Search criteria used to select the folders to return.
 If no search criteria is specified then all accessible folders will be
 returned.

 Query expressions can be used to restrict results based upon displayName,
 state and parent, where the operators `=` (`:`) `NOT`, `AND` and `OR`
 can be used along with the suffix wildcard symbol `*`.

 The `displayName` field in a query expression should use escaped quotes
 for values that include whitespace to prevent unexpected behavior.

 ```
 | Field                   | Description                            |
 |-------------------------|----------------------------------------|
 | displayName             | Filters by displayName.                |
 | parent                  | Filters by parent (for example: folders/123). |
 | state, lifecycleState   | Filters by state.                      |
 ```

 Some example queries are:

 * Query `displayName=Test*` returns Folder resources whose display name
 starts with "Test".
 * Query `state=ACTIVE` returns Folder resources with
 `state` set to `ACTIVE`.
 * Query `parent=folders/123` returns Folder resources that have
 `folders/123` as a parent resource.
 * Query `parent=folders/123 AND state=ACTIVE` returns active
 Folder resources that have `folders/123` as a parent resource.
 * Query `displayName=\\"Test String\\"` returns Folder resources with
 display names that include both "Test" and "String".
      string query = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getQuery in interface SearchFoldersRequestOrBuilder
      Returns:
      The query.

    • getQueryBytes

      public com.google.protobuf.ByteString getQueryBytes()
       Optional. Search criteria used to select the folders to return.
 If no search criteria is specified then all accessible folders will be
 returned.

 Query expressions can be used to restrict results based upon displayName,
 state and parent, where the operators `=` (`:`) `NOT`, `AND` and `OR`
 can be used along with the suffix wildcard symbol `*`.

 The `displayName` field in a query expression should use escaped quotes
 for values that include whitespace to prevent unexpected behavior.

 ```
 | Field                   | Description                            |
 |-------------------------|----------------------------------------|
 | displayName             | Filters by displayName.                |
 | parent                  | Filters by parent (for example: folders/123). |
 | state, lifecycleState   | Filters by state.                      |
 ```

 Some example queries are:

 * Query `displayName=Test*` returns Folder resources whose display name
 starts with "Test".
 * Query `state=ACTIVE` returns Folder resources with
 `state` set to `ACTIVE`.
 * Query `parent=folders/123` returns Folder resources that have
 `folders/123` as a parent resource.
 * Query `parent=folders/123 AND state=ACTIVE` returns active
 Folder resources that have `folders/123` as a parent resource.
 * Query `displayName=\\"Test String\\"` returns Folder resources with
 display names that include both "Test" and "String".
      string query = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getQueryBytes in interface SearchFoldersRequestOrBuilder
      Returns:
      The bytes for query.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SearchFoldersRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchFoldersRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchFoldersRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchFoldersRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchFoldersRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchFoldersRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchFoldersRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchFoldersRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchFoldersRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchFoldersRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchFoldersRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchFoldersRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SearchFoldersRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SearchFoldersRequest.Builder newBuilder()

    • newBuilder

      public static SearchFoldersRequest.Builder newBuilder(SearchFoldersRequest prototype)

    • toBuilder

      public SearchFoldersRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SearchFoldersRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SearchFoldersRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SearchFoldersRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<SearchFoldersRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public SearchFoldersRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder