Reference documentation and code samples for the Google Cloud Cloud Controls Partner V1beta Client class ListCustomersRequest.
Request to list customers
Generated from protobuf message google.cloud.cloudcontrolspartner.v1beta.ListCustomersRequest
Namespace
Google \ Cloud \ CloudControlsPartner \ V1betaMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. Parent resource Format: organizations/{organization}/locations/{location} |
↳ page_size |
int
The maximum number of Customers to return. The service may return fewer than this value. If unspecified, at most 500 Customers will be returned. |
↳ page_token |
string
A page token, received from a previous |
↳ filter |
string
Optional. Filtering results |
↳ order_by |
string
Optional. Hint for how to order the results |
getParent
Required. Parent resource Format: organizations/{organization}/locations/{location}
Returns | |
---|---|
Type | Description |
string |
setParent
Required. Parent resource Format: organizations/{organization}/locations/{location}
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPageSize
The maximum number of Customers to return. The service may return fewer than this value. If unspecified, at most 500 Customers will be returned.
Returns | |
---|---|
Type | Description |
int |
setPageSize
The maximum number of Customers to return. The service may return fewer than this value. If unspecified, at most 500 Customers will be returned.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getPageToken
A page token, received from a previous ListCustomers
call.
Provide this to retrieve the subsequent page.
Returns | |
---|---|
Type | Description |
string |
setPageToken
A page token, received from a previous ListCustomers
call.
Provide this to retrieve the subsequent page.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFilter
Optional. Filtering results
Returns | |
---|---|
Type | Description |
string |
setFilter
Optional. Filtering results
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getOrderBy
Optional. Hint for how to order the results
Returns | |
---|---|
Type | Description |
string |
setOrderBy
Optional. Hint for how to order the results
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameter | |
---|---|
Name | Description |
parent |
string
Required. Parent resource Format: organizations/{organization}/locations/{location} Please see Google\Cloud\CloudControlsPartner\V1beta\CloudControlsPartnerCoreClient::organizationLocationName() for help formatting this field. |
Returns | |
---|---|
Type | Description |
Google\Cloud\CloudControlsPartner\V1beta\ListCustomersRequest |