Class SearchOrganizationsRequest.Builder (1.51.0)

public static final class SearchOrganizationsRequest.Builder extends GeneratedMessageV3.Builder<SearchOrganizationsRequest.Builder> implements SearchOrganizationsRequestOrBuilder

The request sent to the SearchOrganizations method.

Protobuf type google.cloud.resourcemanager.v3.SearchOrganizationsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchOrganizationsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchOrganizationsRequest.Builder
Overrides

build()

public SearchOrganizationsRequest build()
Returns
Type Description
SearchOrganizationsRequest

buildPartial()

public SearchOrganizationsRequest buildPartial()
Returns
Type Description
SearchOrganizationsRequest

clear()

public SearchOrganizationsRequest.Builder clear()
Returns
Type Description
SearchOrganizationsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SearchOrganizationsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SearchOrganizationsRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchOrganizationsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SearchOrganizationsRequest.Builder
Overrides

clearPageSize()

public SearchOrganizationsRequest.Builder clearPageSize()

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
SearchOrganizationsRequest.Builder

This builder for chaining.

clearPageToken()

public SearchOrganizationsRequest.Builder clearPageToken()

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
SearchOrganizationsRequest.Builder

This builder for chaining.

clearQuery()

public SearchOrganizationsRequest.Builder clearQuery()

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
    SearchOrganizationsRequest.Builder

    This builder for chaining.

    clone()

    public SearchOrganizationsRequest.Builder clone()
    Returns
    Type Description
    SearchOrganizationsRequest.Builder
    Overrides

    getDefaultInstanceForType()

    public SearchOrganizationsRequest getDefaultInstanceForType()
    Returns
    Type Description
    SearchOrganizationsRequest

    getDescriptorForType()

    public Descriptors.Descriptor getDescriptorForType()
    Returns
    Type Description
    Descriptor
    Overrides

    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.

    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.

    internalGetFieldAccessorTable()

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

    isInitialized()

    public final boolean isInitialized()
    Returns
    Type Description
    boolean
    Overrides

    mergeFrom(SearchOrganizationsRequest other)

    public SearchOrganizationsRequest.Builder mergeFrom(SearchOrganizationsRequest other)
    Parameter
    Name Description
    other SearchOrganizationsRequest
    Returns
    Type Description
    SearchOrganizationsRequest.Builder

    mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

    public SearchOrganizationsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
    Parameters
    Name Description
    input CodedInputStream
    extensionRegistry ExtensionRegistryLite
    Returns
    Type Description
    SearchOrganizationsRequest.Builder
    Overrides
    Exceptions
    Type Description
    IOException

    mergeFrom(Message other)

    public SearchOrganizationsRequest.Builder mergeFrom(Message other)
    Parameter
    Name Description
    other Message
    Returns
    Type Description
    SearchOrganizationsRequest.Builder
    Overrides

    mergeUnknownFields(UnknownFieldSet unknownFields)

    public final SearchOrganizationsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
    Parameter
    Name Description
    unknownFields UnknownFieldSet
    Returns
    Type Description
    SearchOrganizationsRequest.Builder
    Overrides

    setField(Descriptors.FieldDescriptor field, Object value)

    public SearchOrganizationsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
    Parameters
    Name Description
    field FieldDescriptor
    value Object
    Returns
    Type Description
    SearchOrganizationsRequest.Builder
    Overrides

    setPageSize(int value)

    public SearchOrganizationsRequest.Builder setPageSize(int value)

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

    Parameter
    Name Description
    value int

    The pageSize to set.

    Returns
    Type Description
    SearchOrganizationsRequest.Builder

    This builder for chaining.

    setPageToken(String value)

    public SearchOrganizationsRequest.Builder setPageToken(String value)

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

    Parameter
    Name Description
    value String

    The pageToken to set.

    Returns
    Type Description
    SearchOrganizationsRequest.Builder

    This builder for chaining.

    setPageTokenBytes(ByteString value)

    public SearchOrganizationsRequest.Builder setPageTokenBytes(ByteString value)

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

    Parameter
    Name Description
    value ByteString

    The bytes for pageToken to set.

    Returns
    Type Description
    SearchOrganizationsRequest.Builder

    This builder for chaining.

    setQuery(String value)

    public SearchOrganizationsRequest.Builder setQuery(String value)

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

    Parameter
    Name Description
    value String

    The query to set.

    Returns
    Type Description
    SearchOrganizationsRequest.Builder

    This builder for chaining.

    setQueryBytes(ByteString value)

    public SearchOrganizationsRequest.Builder setQueryBytes(ByteString value)

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

    Parameter
    Name Description
    value ByteString

    The bytes for query to set.

    Returns
    Type Description
    SearchOrganizationsRequest.Builder

    This builder for chaining.

    setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

    public SearchOrganizationsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
    Parameters
    Name Description
    field FieldDescriptor
    index int
    value Object
    Returns
    Type Description
    SearchOrganizationsRequest.Builder
    Overrides

    setUnknownFields(UnknownFieldSet unknownFields)

    public final SearchOrganizationsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
    Parameter
    Name Description
    unknownFields UnknownFieldSet
    Returns
    Type Description
    SearchOrganizationsRequest.Builder
    Overrides