Interface SearchOrganizationsRequestOrBuilder (1.57.0) 

public interface SearchOrganizationsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getPageSize()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.