Google Cloud Channel V1 Client - Class ListCustomersRequest (1.6.0)

Reference documentation and code samples for the Google Cloud Channel V1 Client class ListCustomersRequest.

Request message for CloudChannelService.ListCustomers

Generated from protobuf message google.cloud.channel.v1.ListCustomersRequest

Namespace

Google \ Cloud \ Channel \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The resource name of the reseller account to list customers from. Parent uses the format: accounts/{account_id}.

↳ page_size int

Optional. The maximum number of customers to return. The service may return fewer than this value. If unspecified, returns at most 10 customers. The maximum value is 50.

↳ page_token string

Optional. A token identifying a page of results other than the first page. Obtained through ListCustomersResponse.next_page_token of the previous CloudChannelService.ListCustomers call.

↳ filter string

Optional. Filters applied to the [CloudChannelService.ListCustomers] results. See https://cloud.google.com/channel/docs/concepts/google-cloud/filter-customers for more information.

getParent

Required. The resource name of the reseller account to list customers from.

Parent uses the format: accounts/{account_id}.

Returns
TypeDescription
string

setParent

Required. The resource name of the reseller account to list customers from.

Parent uses the format: accounts/{account_id}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

Optional. The maximum number of customers to return. The service may return fewer than this value. If unspecified, returns at most 10 customers. The maximum value is 50.

Returns
TypeDescription
int

setPageSize

Optional. The maximum number of customers to return. The service may return fewer than this value. If unspecified, returns at most 10 customers. The maximum value is 50.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

Optional. A token identifying a page of results other than the first page.

Obtained through ListCustomersResponse.next_page_token of the previous CloudChannelService.ListCustomers call.

Returns
TypeDescription
string

setPageToken

Optional. A token identifying a page of results other than the first page.

Obtained through ListCustomersResponse.next_page_token of the previous CloudChannelService.ListCustomers call.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

Optional. Filters applied to the [CloudChannelService.ListCustomers] results. See https://cloud.google.com/channel/docs/concepts/google-cloud/filter-customers for more information.

Returns
TypeDescription
string

setFilter

Optional. Filters applied to the [CloudChannelService.ListCustomers] results. See https://cloud.google.com/channel/docs/concepts/google-cloud/filter-customers for more information.

Parameter
NameDescription
var string
Returns
TypeDescription
$this