Class SearchOrganizationsRequest (1.57.0) 

public final class SearchOrganizationsRequest extends GeneratedMessageV3 implements SearchOrganizationsRequestOrBuilder

The request sent to the SearchOrganizations method.

Protobuf type google.cloud.resourcemanager.v3.SearchOrganizationsRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchOrganizationsRequest

Static Fields

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchOrganizationsRequest getDefaultInstance()
Returns
Type Description
SearchOrganizationsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchOrganizationsRequest.Builder newBuilder()
Returns
Type Description
SearchOrganizationsRequest.Builder

newBuilder(SearchOrganizationsRequest prototype)

public static SearchOrganizationsRequest.Builder newBuilder(SearchOrganizationsRequest prototype)
Parameter
Name Description
prototype SearchOrganizationsRequest
Returns
Type Description
SearchOrganizationsRequest.Builder

parseDelimitedFrom(InputStream input)

public static SearchOrganizationsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchOrganizationsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchOrganizationsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchOrganizationsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchOrganizationsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchOrganizationsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchOrganizationsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchOrganizationsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchOrganizationsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchOrganizationsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchOrganizationsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchOrganizationsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchOrganizationsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchOrganizationsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchOrganizationsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchOrganizationsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchOrganizationsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchOrganizationsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchOrganizationsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchOrganizationsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchOrganizationsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchOrganizationsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchOrganizationsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchOrganizationsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchOrganizationsRequest> parser()
Returns
Type Description
Parser<SearchOrganizationsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SearchOrganizationsRequest getDefaultInstanceForType()
Returns
Type Description
SearchOrganizationsRequest

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];

Returns
Type Description
int

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];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public 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
Type Description
ByteString

The bytes for pageToken.

getParserForType()

public Parser<SearchOrganizationsRequest> getParserForType()
Returns
Type Description
Parser<SearchOrganizationsRequest>
Overrides

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];

    Returns
    Type Description
    String

    The query.

    getQueryBytes()

    public 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
    Type Description
    ByteString

    The bytes for query.

    getSerializedSize()

    public int getSerializedSize()
    Returns
    Type Description
    int
    Overrides

    hashCode()

    public int hashCode()
    Returns
    Type Description
    int
    Overrides

    internalGetFieldAccessorTable()

    protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
    Returns
    Type Description
    FieldAccessorTable
    Overrides

    isInitialized()

    public final boolean isInitialized()
    Returns
    Type Description
    boolean
    Overrides

    newBuilderForType()

    public SearchOrganizationsRequest.Builder newBuilderForType()
    Returns
    Type Description
    SearchOrganizationsRequest.Builder

    newBuilderForType(GeneratedMessageV3.BuilderParent parent)

    protected SearchOrganizationsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
    Parameter
    Name Description
    parent BuilderParent
    Returns
    Type Description
    SearchOrganizationsRequest.Builder
    Overrides

    newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

    protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
    Parameter
    Name Description
    unused UnusedPrivateParameter
    Returns
    Type Description
    Object
    Overrides

    toBuilder()

    public SearchOrganizationsRequest.Builder toBuilder()
    Returns
    Type Description
    SearchOrganizationsRequest.Builder

    writeTo(CodedOutputStream output)

    public void writeTo(CodedOutputStream output)
    Parameter
    Name Description
    output CodedOutputStream
    Overrides
    Exceptions
    Type Description
    IOException