Package com.google.cloud.resourcemanager.v3

Class SearchOrganizationsRequest

  • All Implemented Interfaces:
    SearchOrganizationsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class SearchOrganizationsRequest
extends com.google.protobuf.GeneratedMessageV3
implements SearchOrganizationsRequestOrBuilder
     The request sent to the `SearchOrganizations` method.
    Protobuf type google.cloud.resourcemanager.v3.SearchOrganizationsRequest
    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 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];
        Specified by:
        getPageSize in interface SearchOrganizationsRequestOrBuilder
        Returns:
        The pageSize.

      • getPageToken

        public 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];
        Specified by:
        getPageToken in interface SearchOrganizationsRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public 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];
        Specified by:
        getPageTokenBytes in interface SearchOrganizationsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • getQuery

        public 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];
        Specified by:
        getQuery in interface SearchOrganizationsRequestOrBuilder
        Returns:
        The query.

      • getQueryBytes

        public 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];
        Specified by:
        getQueryBytes in interface SearchOrganizationsRequestOrBuilder
        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 SearchOrganizationsRequest parseFrom​(ByteBuffer data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected SearchOrganizationsRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<SearchOrganizationsRequest> 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 SearchOrganizationsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder