As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Essential Contacts v1 API

class google.cloud.essential_contacts_v1.types.ComputeContactsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the ComputeContacts method.

parent

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

Type

str

notification_categories

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

Type

MutableSequence[google.cloud.essential_contacts_v1.types.NotificationCategory]

page_size

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.

Type

int

page_token

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.

Type

str

class google.cloud.essential_contacts_v1.types.ComputeContactsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for the ComputeContacts method.

contacts

All contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.

Type

MutableSequence[google.cloud.essential_contacts_v1.types.Contact]

next_page_token

If there are more results than those appearing in this response, then next_page_token is included. To get the next set of results, call this method again using the value of next_page_token as page_token and the rest of the parameters the same as the original request.

Type

str

class google.cloud.essential_contacts_v1.types.Contact(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A contact that will receive notifications from Google Cloud.

name

Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}

Type

str

email

Required. The email address to send notifications to. The email address does not need to be a Google Account.

Type

str

notification_category_subscriptions

Required. The categories of notifications that the contact will receive communications for.

Type

MutableSequence[google.cloud.essential_contacts_v1.types.NotificationCategory]

language_tag

Required. The preferred language for notifications, as a ISO 639-1 language code. See Supported languages for a list of supported languages.

Type

str

validation_state

Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.

Type

google.cloud.essential_contacts_v1.types.ValidationState

validate_time

The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.essential_contacts_v1.types.CreateContactRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the CreateContact method.

parent

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

Type

str

contact

Required. The contact to create. Must specify an email address and language tag.

Type

google.cloud.essential_contacts_v1.types.Contact

class google.cloud.essential_contacts_v1.types.DeleteContactRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the DeleteContact method.

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}

Type

str

class google.cloud.essential_contacts_v1.types.GetContactRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the GetContact method.

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}

Type

str

class google.cloud.essential_contacts_v1.types.ListContactsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the ListContacts method.

parent

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

Type

str

page_size

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.

Type

int

page_token

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.

Type

str

class google.cloud.essential_contacts_v1.types.ListContactsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for the ListContacts method.

contacts

The contacts for the specified resource.

Type

MutableSequence[google.cloud.essential_contacts_v1.types.Contact]

next_page_token

If there are more results than those appearing in this response, then next_page_token is included. To get the next set of results, call this method again using the value of next_page_token as page_token and the rest of the parameters the same as the original request.

Type

str

class google.cloud.essential_contacts_v1.types.NotificationCategory(value)

Bases: proto.enums.Enum

The notification categories that an essential contact can be subscribed to. Each notification will be categorized by the sender into one of the following categories. All contacts that are subscribed to that category will receive the notification.

Values:

NOTIFICATION_CATEGORY_UNSPECIFIED (0):

Notification category is unrecognized or unspecified.

ALL (2):

All notifications related to the resource, including notifications pertaining to categories added in the future.

SUSPENSION (3):

Notifications related to imminent account suspension.

SECURITY (5):

Notifications related to security/privacy incidents, notifications, and vulnerabilities.

TECHNICAL (6):

Notifications related to technical events and issues such as outages, errors, or bugs.

BILLING (7):

Notifications related to billing and payments notifications, price updates, errors, or credits.

LEGAL (8):

Notifications related to enforcement actions, regulatory compliance, or government notices.

PRODUCT_UPDATES (9):

Notifications related to new versions, product terms updates, or deprecations.

TECHNICAL_INCIDENTS (10):

Child category of TECHNICAL. If assigned, technical incident notifications will go to these contacts instead of TECHNICAL.

class google.cloud.essential_contacts_v1.types.SendTestMessageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the SendTestMessage method.

contacts

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}

Type

MutableSequence[str]

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}

Type

str

notification_category

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

Type

google.cloud.essential_contacts_v1.types.NotificationCategory

class google.cloud.essential_contacts_v1.types.UpdateContactRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the UpdateContact method.

contact

Required. The contact resource to replace the existing saved contact. Note: the email address of the contact cannot be modified.

Type

google.cloud.essential_contacts_v1.types.Contact

update_mask

Optional. The update mask applied to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.essential_contacts_v1.types.ValidationState(value)

Bases: proto.enums.Enum

A contact’s validation state indicates whether or not it is the correct contact to be receiving notifications for a particular resource.

Values:

VALIDATION_STATE_UNSPECIFIED (0):

The validation state is unknown or unspecified.

VALID (1):

The contact is marked as valid. This is usually done manually by the contact admin. All new contacts begin in the valid state.

INVALID (2):

The contact is considered invalid. This may become the state if the contact’s email is found to be unreachable.