Reference documentation and code samples for the Google Cloud Resource Manager V3 Client class SearchOrganizationsRequest.
The request sent to the SearchOrganizations
method.
Generated from protobuf message google.cloud.resourcemanager.v3.SearchOrganizationsRequest
Namespace
Google \ Cloud \ ResourceManager \ V3Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ page_size |
int
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. |
↳ page_token |
string
Optional. A pagination token returned from a previous call to |
↳ query |
string
Optional. An optional query string used to filter the Organizations to return in the response. Query rules are case-insensitive. |
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.
Returns | |
---|---|
Type | Description |
int |
setPageSize
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.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getPageToken
Optional. A pagination token returned from a previous call to
SearchOrganizations
that indicates from where listing should continue.
Returns | |
---|---|
Type | Description |
string |
setPageToken
Optional. A pagination token returned from a previous call to
SearchOrganizations
that indicates from where listing should continue.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
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 withowner.directory_customer_id
equal to123456789
. - Query
domain:google.com
returns Organization resources corresponding to the domaingoogle.com
.
Returns | |
---|---|
Type | Description |
string |
setQuery
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 withowner.directory_customer_id
equal to123456789
. - Query
domain:google.com
returns Organization resources corresponding to the domaingoogle.com
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameter | |
---|---|
Name | Description |
query |
string
Optional. An optional query string used to filter the Organizations to return in the response. Query rules are case-insensitive.
Organizations may be queried by
|
Returns | |
---|---|
Type | Description |
Google\Cloud\ResourceManager\V3\SearchOrganizationsRequest |