Google Cloud Essential Contacts V1 Client - Class SendTestMessageRequest (1.0.0)

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

Request message for the SendTestMessage method.

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

Namespace

Google \ Cloud \ EssentialContacts \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ contacts array

Required. The list of names of the contacts to send a test message to. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}

↳ resource string

Required. The name of the resource to send the test message for. All contacts must either be set directly on this resource or inherited from another resource that is an ancestor of this one. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}

↳ notification_category int

Required. The notification category to send the test message for. All contacts must be subscribed to this category.

getContacts

Required. The list of names of the contacts to send a test message to.

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setContacts

Required. The list of names of the contacts to send a test message to.

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

Parameter
Name Description
var string[]
Returns
Type Description
$this

getResource

Required. The name of the resource to send the test message for. All contacts must either be set directly on this resource or inherited from another resource that is an ancestor of this one. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}

Returns
Type Description
string

setResource

Required. The name of the resource to send the test message for. All contacts must either be set directly on this resource or inherited from another resource that is an ancestor of this one. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getNotificationCategory

Required. The notification category to send the test message for. All contacts must be subscribed to this category.

Returns
Type Description
int

setNotificationCategory

Required. The notification category to send the test message for. All contacts must be subscribed to this category.

Parameter
Name Description
var int
Returns
Type Description
$this