Package com.google.cloud.resourcemanager.v3

Class SearchFoldersRequest

  • All Implemented Interfaces:
    SearchFoldersRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class SearchFoldersRequest
extends com.google.protobuf.GeneratedMessageV3
implements SearchFoldersRequestOrBuilder
     The request message for searching folders.
    Protobuf type google.cloud.resourcemanager.v3.SearchFoldersRequest
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • 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.GeneratedMessageV3

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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

      • newBuilderForType

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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

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