1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Essentialcontacts
  7. \
  8. Resource
  9. \
  10. FoldersContacts

FoldersContacts

class FoldersContacts extends Resource (View source)

The "contacts" collection of methods.

Typical usage is:

 $essentialcontactsService = new Google\Service\Essentialcontacts(...);
 $contacts = $essentialcontactsService->folders_contacts;

Methods

GoogleCloudEssentialcontactsV1ComputeContactsResponse
compute(string $parent, array $optParams = [])

Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources. (contacts.compute)

GoogleCloudEssentialcontactsV1Contact
create(string $parent, GoogleCloudEssentialcontactsV1Contact $postBody, array $optParams = [])

Adds a new contact for a resource. (contacts.create)

GoogleProtobufEmpty
delete(string $name, array $optParams = [])

Deletes a contact. (contacts.delete)

GoogleCloudEssentialcontactsV1Contact
get(string $name, array $optParams = [])

Gets a single contact. (contacts.get)

GoogleCloudEssentialcontactsV1ListContactsResponse
listFoldersContacts(string $parent, array $optParams = [])

Lists the contacts that have been set on a resource.

GoogleCloudEssentialcontactsV1Contact
patch(string $name, GoogleCloudEssentialcontactsV1Contact $postBody, array $optParams = [])

Updates a contact. Note: A contact's email address cannot be changed.

GoogleProtobufEmpty
sendTestMessage(string $resource, GoogleCloudEssentialcontactsV1SendTestMessageRequest $postBody, array $optParams = [])

Allows a contact admin to send a test message to contact to verify that it has been configured correctly. (contacts.sendTestMessage)

Details

at line 60
GoogleCloudEssentialcontactsV1ComputeContactsResponse compute(string $parent, array $optParams = [])

Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources. (contacts.compute)

Parameters

string $parent

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

Optional parameters.

Return Value

GoogleCloudEssentialcontactsV1ComputeContactsResponse

Exceptions

Exception

at line 77
GoogleCloudEssentialcontactsV1Contact create(string $parent, GoogleCloudEssentialcontactsV1Contact $postBody, array $optParams = [])

Adds a new contact for a resource. (contacts.create)

Parameters

string $parent

Required. The resource to save this contact for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}
GoogleCloudEssentialcontactsV1Contact $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudEssentialcontactsV1Contact

Exceptions

Exception

at line 94
GoogleProtobufEmpty delete(string $name, array $optParams = [])

Deletes a contact. (contacts.delete)

Parameters

string $name

Required. The name of the contact to delete. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

at line 111
GoogleCloudEssentialcontactsV1Contact get(string $name, array $optParams = [])

Gets a single contact. (contacts.get)

Parameters

string $name

Required. The name of the contact to retrieve. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}
array $optParams

Optional parameters.

Return Value

GoogleCloudEssentialcontactsV1Contact

Exceptions

Exception

at line 136
GoogleCloudEssentialcontactsV1ListContactsResponse listFoldersContacts(string $parent, array $optParams = [])

Lists the contacts that have been set on a resource.

(contacts.listFoldersContacts)

Parameters

string $parent

Required. The parent resource name. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}
array $optParams

Optional parameters.

Return Value

GoogleCloudEssentialcontactsV1ListContactsResponse

Exceptions

Exception

at line 158
GoogleCloudEssentialcontactsV1Contact patch(string $name, GoogleCloudEssentialcontactsV1Contact $postBody, array $optParams = [])

Updates a contact. Note: A contact's email address cannot be changed.

(contacts.patch)

Parameters

string $name

Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
GoogleCloudEssentialcontactsV1Contact $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudEssentialcontactsV1Contact

Exceptions

Exception

at line 177
GoogleProtobufEmpty sendTestMessage(string $resource, GoogleCloudEssentialcontactsV1SendTestMessageRequest $postBody, array $optParams = [])

Allows a contact admin to send a test message to contact to verify that it has been configured correctly. (contacts.sendTestMessage)

Parameters

string $resource

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}
GoogleCloudEssentialcontactsV1SendTestMessageRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception