Google Cloud Essential Contacts V1 Client - Class ListContactsRequest (0.3.4)

Version 0.3.4

• 1.0.2 (latest)
• 1.0.1
• 0.4.5
• 0.3.4
• 0.2.13

Reference documentation and code samples for the Google Cloud Essential Contacts V1 Client class ListContactsRequest.

Request message for the ListContacts method.

Generated from protobuf message google.cloud.essentialcontacts.v1.ListContactsRequest

Namespace

Google \ Cloud \ EssentialContacts \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The parent resource name. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}
↳ page_size	int Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available. If not specified, the default page_size is 100.
↳ page_token	string Optional. If present, retrieves the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.

getParent

Required. The parent resource name.

Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}

Returns
Type	Description
string

setParent

Required. The parent resource name.

Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

Optional. The maximum number of results to return from this request.

Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available. If not specified, the default page_size is 100.

Returns
Type	Description
int

setPageSize

Optional. The maximum number of results to return from this request.

Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available. If not specified, the default page_size is 100.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

Optional. If present, retrieves the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.

Returns
Type	Description
string

setPageToken

Optional. If present, retrieves the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
parent	string Required. The parent resource name. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} Please see Google\Cloud\EssentialContacts\V1\EssentialContactsServiceClient::projectName() for help formatting this field.

Returns
Type	Description
Google\Cloud\EssentialContacts\V1\ListContactsRequest