Package com.google.cloud.resourcemanager.v3

Interface SearchFoldersRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SearchFoldersRequest, SearchFoldersRequest.Builder
@Generated public interface SearchFoldersRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getPageSize()
    Optional.
    String
    getPageToken()
    Optional.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Optional.
    String
    getQuery()
    Optional.
    com.google.protobuf.ByteString
    getQueryBytes()
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getPageSize

      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];
      Returns:
      The pageSize.

    • getPageToken

      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];
      Returns:
      The pageToken.

    • getPageTokenBytes

      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];
      Returns:
      The bytes for pageToken.

    • getQuery

      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];
      Returns:
      The query.

    • getQueryBytes

      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];
      Returns:
      The bytes for query.