Package com.google.cloud.resourcemanager.v3

Class SearchFoldersRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchFoldersRequest.Builder>
com.google.cloud.resourcemanager.v3.SearchFoldersRequest.Builder
All Implemented Interfaces:
SearchFoldersRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SearchFoldersRequest
public static final class SearchFoldersRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<SearchFoldersRequest.Builder> implements SearchFoldersRequestOrBuilder
 The request message for searching folders.
Protobuf type google.cloud.resourcemanager.v3.SearchFoldersRequest

  • 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.Builder<SearchFoldersRequest.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SearchFoldersRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public SearchFoldersRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchFoldersRequest.Builder>

    • mergeFrom

      public SearchFoldersRequest.Builder mergeFrom(SearchFoldersRequest other)

    • isInitialized

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

    • mergeFrom

      public SearchFoldersRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchFoldersRequest.Builder>
      Throws:
      IOException

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

    • setPageSize

      public SearchFoldersRequest.Builder setPageSize(int value)
       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];
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public SearchFoldersRequest.Builder clearPageSize()
       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];
      Returns:
      This builder for chaining.

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

    • setPageToken

      public SearchFoldersRequest.Builder setPageToken(String value)
       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];
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public SearchFoldersRequest.Builder clearPageToken()
       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];
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public SearchFoldersRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

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

    • setQuery

      public SearchFoldersRequest.Builder setQuery(String value)
       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];
      Parameters:
      value - The query to set.
      Returns:
      This builder for chaining.

    • clearQuery

      public SearchFoldersRequest.Builder clearQuery()
       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];
      Returns:
      This builder for chaining.

    • setQueryBytes

      public SearchFoldersRequest.Builder setQueryBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for query to set.
      Returns:
      This builder for chaining.