Class EssentialContactsServiceClient (1.9.0)

EssentialContactsServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.essential_contacts_v1.services.essential_contacts_service.transports.base.EssentialContactsServiceTransport, typing.Callable[[...], google.cloud.essential_contacts_v1.services.essential_contacts_service.transports.base.EssentialContactsServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Manages contacts for important Google Cloud notifications.

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type	Description
`str`	The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type	Description
`EssentialContactsServiceTransport`	The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type	Description
`str`	The universe domain used by the client instance.

Methods

EssentialContactsServiceClient

EssentialContactsServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.essential_contacts_v1.services.essential_contacts_service.transports.base.EssentialContactsServiceTransport, typing.Callable[[...], google.cloud.essential_contacts_v1.services.essential_contacts_service.transports.base.EssentialContactsServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the essential contacts service client.

Parameters
Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Optional[Union[str,EssentialContactsServiceTransport,Callable[..., EssentialContactsServiceTransport]]]` The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the EssentialContactsServiceTransport constructor. If set to None, a transport is chosen automatically.
`client_options`	`Optional[Union[google.api_core.client_options.ClientOptions, dict]]` Custom options for the client. 1. The `api_endpoint` property can be used to override the default endpoint provided by the client when `transport` is not explicitly provided. Only if this property is not set and `transport` was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The `universe_domain` property can be used to override the default "googleapis.com" universe. Note that the `api_endpoint` property still takes precedence; and `universe_domain` is currently not supported for mTLS.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

compute_contacts

compute_contacts(
    request: typing.Optional[
        typing.Union[
            google.cloud.essential_contacts_v1.types.service.ComputeContactsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ComputeContactsPager
)

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import essential_contacts_v1

def sample_compute_contacts():
    # Create a client
    client = essential_contacts_v1.EssentialContactsServiceClient()

    # Initialize request argument(s)
    request = essential_contacts_v1.ComputeContactsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.compute_contacts(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.essential_contacts_v1.types.ComputeContactsRequest, dict]` The request object. Request message for the ComputeContacts method.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ComputeContactsPager`	Response message for the ComputeContacts method. Iterating over this object will yield results and resolve additional pages automatically.

contact_path

contact_path(project: str, contact: str) -> str

Returns a fully-qualified contact string.

create_contact

create_contact(
    request: typing.Optional[
        typing.Union[
            google.cloud.essential_contacts_v1.types.service.CreateContactRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    contact: typing.Optional[
        google.cloud.essential_contacts_v1.types.service.Contact
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.essential_contacts_v1.types.service.Contact

Adds a new contact for a resource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import essential_contacts_v1

def sample_create_contact():
    # Create a client
    client = essential_contacts_v1.EssentialContactsServiceClient()

    # Initialize request argument(s)
    contact = essential_contacts_v1.Contact()
    contact.email = "email_value"
    contact.notification_category_subscriptions = ['TECHNICAL_INCIDENTS']
    contact.language_tag = "language_tag_value"

    request = essential_contacts_v1.CreateContactRequest(
        parent="parent_value",
        contact=contact,
    )

    # Make the request
    response = client.create_contact(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.essential_contacts_v1.types.CreateContactRequest, dict]` The request object. Request message for the CreateContact method.
`parent`	`str` Required. The resource to save this contact for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`contact`	`google.cloud.essential_contacts_v1.types.Contact` Required. The contact to create. Must specify an email address and language tag. This corresponds to the `contact` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.essential_contacts_v1.types.Contact`	A contact that will receive notifications from Google Cloud.

delete_contact

delete_contact(
    request: typing.Optional[
        typing.Union[
            google.cloud.essential_contacts_v1.types.service.DeleteContactRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a contact.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import essential_contacts_v1

def sample_delete_contact():
    # Create a client
    client = essential_contacts_v1.EssentialContactsServiceClient()

    # Initialize request argument(s)
    request = essential_contacts_v1.DeleteContactRequest(
        name="name_value",
    )

    # Make the request
    client.delete_contact(request=request)

Parameters
Name	Description
`request`	`Union[google.cloud.essential_contacts_v1.types.DeleteContactRequest, dict]` The request object. Request message for the DeleteContact method.
`name`	`str` 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} This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`EssentialContactsServiceClient`	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name	Description
`info`	`dict` The service account private key info.

Returns
Type	Description
`EssentialContactsServiceClient`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`EssentialContactsServiceClient`	The constructed client.

get_contact

get_contact(
    request: typing.Optional[
        typing.Union[
            google.cloud.essential_contacts_v1.types.service.GetContactRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.essential_contacts_v1.types.service.Contact

Gets a single contact.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import essential_contacts_v1

def sample_get_contact():
    # Create a client
    client = essential_contacts_v1.EssentialContactsServiceClient()

    # Initialize request argument(s)
    request = essential_contacts_v1.GetContactRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_contact(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.essential_contacts_v1.types.GetContactRequest, dict]` The request object. Request message for the GetContact method.
`name`	`str` 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} This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.essential_contacts_v1.types.Contact`	A contact that will receive notifications from Google Cloud.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name	Description
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If any errors happen.

Returns
Type	Description
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	returns the API endpoint and the client cert source to use.

list_contacts

list_contacts(
    request: typing.Optional[
        typing.Union[
            google.cloud.essential_contacts_v1.types.service.ListContactsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ListContactsPager
)

Lists the contacts that have been set on a resource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import essential_contacts_v1

def sample_list_contacts():
    # Create a client
    client = essential_contacts_v1.EssentialContactsServiceClient()

    # Initialize request argument(s)
    request = essential_contacts_v1.ListContactsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_contacts(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.essential_contacts_v1.types.ListContactsRequest, dict]` The request object. Request message for the ListContacts method.
`parent`	`str` Required. The parent resource name. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ListContactsPager`	Response message for the ListContacts method. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_contact_path

parse_contact_path(path: str) -> typing.Dict[str, str]

Parses a contact path into its component segments.

send_test_message

send_test_message(
    request: typing.Optional[
        typing.Union[
            google.cloud.essential_contacts_v1.types.service.SendTestMessageRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import essential_contacts_v1

def sample_send_test_message():
    # Create a client
    client = essential_contacts_v1.EssentialContactsServiceClient()

    # Initialize request argument(s)
    request = essential_contacts_v1.SendTestMessageRequest(
        contacts=['contacts_value1', 'contacts_value2'],
        resource="resource_value",
        notification_category="TECHNICAL_INCIDENTS",
    )

    # Make the request
    client.send_test_message(request=request)

Parameters
Name	Description
`request`	`Union[google.cloud.essential_contacts_v1.types.SendTestMessageRequest, dict]` The request object. Request message for the SendTestMessage method.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

update_contact

update_contact(
    request: typing.Optional[
        typing.Union[
            google.cloud.essential_contacts_v1.types.service.UpdateContactRequest, dict
        ]
    ] = None,
    *,
    contact: typing.Optional[
        google.cloud.essential_contacts_v1.types.service.Contact
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.essential_contacts_v1.types.service.Contact

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import essential_contacts_v1

def sample_update_contact():
    # Create a client
    client = essential_contacts_v1.EssentialContactsServiceClient()

    # Initialize request argument(s)
    contact = essential_contacts_v1.Contact()
    contact.email = "email_value"
    contact.notification_category_subscriptions = ['TECHNICAL_INCIDENTS']
    contact.language_tag = "language_tag_value"

    request = essential_contacts_v1.UpdateContactRequest(
        contact=contact,
    )

    # Make the request
    response = client.update_contact(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.essential_contacts_v1.types.UpdateContactRequest, dict]` The request object. Request message for the UpdateContact method.
`contact`	`google.cloud.essential_contacts_v1.types.Contact` Required. The contact resource to replace the existing saved contact. Note: the email address of the contact cannot be modified. This corresponds to the `contact` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Optional. The update mask applied to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.essential_contacts_v1.types.Contact`	A contact that will receive notifications from Google Cloud.