Interface SearchOrganizationsRequestOrBuilder (1.57.0)

Version latest

• 1.57.0 (latest)
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.6
• 1.4.0
• 1.3.2
• 1.2.12

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.