Package com.google.cloud.resourcemanager.v3

Interface SearchOrganizationsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SearchOrganizationsRequest, SearchOrganizationsRequest.Builder
@Generated public interface SearchOrganizationsRequestOrBuilder 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 organizations to return in the response.
 The server can return fewer organizations 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
 `SearchOrganizations` that indicates from where listing 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
 `SearchOrganizations` that indicates from where listing should continue.
      string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for pageToken.

    • getQuery

      String getQuery()
       Optional. An optional query string used to filter the Organizations to
 return in the response. Query rules are case-insensitive.


 ```
 | Field            | Description                                |
 |------------------|--------------------------------------------|
 | directoryCustomerId, owner.directoryCustomerId | Filters by directory
 customer id. |
 | domain           | Filters by domain.                         |
 ```

 Organizations may be queried by `directoryCustomerId` or by
 `domain`, where the domain is a G Suite domain, for example:

 * Query `directorycustomerid:123456789` returns Organization
 resources with `owner.directory_customer_id` equal to `123456789`.
 * Query `domain:google.com` returns Organization resources corresponding
 to the domain `google.com`.
      string query = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The query.

    • getQueryBytes

      com.google.protobuf.ByteString getQueryBytes()
       Optional. An optional query string used to filter the Organizations to
 return in the response. Query rules are case-insensitive.


 ```
 | Field            | Description                                |
 |------------------|--------------------------------------------|
 | directoryCustomerId, owner.directoryCustomerId | Filters by directory
 customer id. |
 | domain           | Filters by domain.                         |
 ```

 Organizations may be queried by `directoryCustomerId` or by
 `domain`, where the domain is a G Suite domain, for example:

 * Query `directorycustomerid:123456789` returns Organization
 resources with `owner.directory_customer_id` equal to `123456789`.
 * Query `domain:google.com` returns Organization resources corresponding
 to the domain `google.com`.
      string query = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for query.