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

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

Request message for the ComputeContacts method.

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

Namespace

Google \ Cloud \ EssentialContacts \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The name of the resource to compute contacts for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}

↳ notification_categories array

The categories of notifications to compute contacts for. If ALL is included in this list, contacts subscribed to any notification category will be returned.

↳ 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 name of the resource to compute contacts for.

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

Returns
TypeDescription
string

setParent

Required. The name of the resource to compute contacts for.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNotificationCategories

The categories of notifications to compute contacts for. If ALL is included in this list, contacts subscribed to any notification category will be returned.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setNotificationCategories

The categories of notifications to compute contacts for. If ALL is included in this list, contacts subscribed to any notification category will be returned.

Parameter
NameDescription
var int[]
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this