Class NotificationChannelServiceClient (2.6.0)

NotificationChannelServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.monitoring_v3.services.notification_channel_service.transports.base.NotificationChannelServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

The Notification Channel API provides access to configuration that controls how messages related to incidents are sent.

Properties

transport

Returns the transport used by the client instance.

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

Methods

NotificationChannelServiceClient

NotificationChannelServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.monitoring_v3.services.notification_channel_service.transports.base.NotificationChannelServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the notification channel 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`	`Union[str, NotificationChannelServiceTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "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). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS 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.
`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)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_notification_channel

create_notification_channel(request: Optional[Union[google.cloud.monitoring_v3.types.notification_service.CreateNotificationChannelRequest, dict]] = None, *, name: Optional[str] = None, notification_channel: Optional[google.cloud.monitoring_v3.types.notification.NotificationChannel] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.CreateNotificationChannelRequest, dict]` The request object. The `CreateNotificationChannel` request.
`name`	`str` Required. The `project https://cloud.google.com/monitoring/api/v3#project_name`__ on which to execute the request. The format is: :: projects/[PROJECT_ID_OR_NUMBER] This names the container into which the channel will be written, this does not name the newly created channel. The resulting channel's name will have a normalized version of this field as a prefix, but will add `/notificationChannels/[CHANNEL_ID]` to identify the channel. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`notification_channel`	`google.cloud.monitoring_v3.types.NotificationChannel` Required. The definition of the `NotificationChannel` to create. This corresponds to the `notification_channel` 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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.monitoring_v3.types.NotificationChannel`	A NotificationChannel is a medium through which an alert is delivered when a policy violation is detected. Examples of channels include email, SMS, and third-party messaging applications. Fields containing sensitive information like authentication tokens or contact info are only partially populated on retrieval.

delete_notification_channel

delete_notification_channel(request: Optional[Union[google.cloud.monitoring_v3.types.notification_service.DeleteNotificationChannelRequest, dict]] = None, *, name: Optional[str] = None, force: Optional[bool] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a notification channel.

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.DeleteNotificationChannelRequest, dict]` The request object. The `DeleteNotificationChannel` request.
`name`	`str` Required. The channel for which to execute the request. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`force`	`bool` If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation. This corresponds to the `force` 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, str]]` Strings which should be sent along with the request as metadata.

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
`NotificationChannelServiceClient`	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
`NotificationChannelServiceClient`	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
`NotificationChannelServiceClient`	The constructed client.

get_notification_channel

get_notification_channel(request: Optional[Union[google.cloud.monitoring_v3.types.notification_service.GetNotificationChannelRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a single notification channel. The channel includes the relevant configuration details with which the channel was created. However, the response may truncate or omit passwords, API keys, or other private key matter and thus the response may not be 100% identical to the information that was supplied in the call to the create method.

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.GetNotificationChannelRequest, dict]` The request object. The `GetNotificationChannel` request.
`name`	`str` Required. The channel for which to execute the request. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.monitoring_v3.types.NotificationChannel`	A NotificationChannel is a medium through which an alert is delivered when a policy violation is detected. Examples of channels include email, SMS, and third-party messaging applications. Fields containing sensitive information like authentication tokens or contact info are only partially populated on retrieval.

get_notification_channel_descriptor

get_notification_channel_descriptor(request: Optional[Union[google.cloud.monitoring_v3.types.notification_service.GetNotificationChannelDescriptorRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a single channel descriptor. The descriptor indicates which fields are expected / permitted for a notification channel of the given type.

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.GetNotificationChannelDescriptorRequest, dict]` The request object. The `GetNotificationChannelDescriptor` response.
`name`	`str` Required. The channel type for which to execute the request. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[CHANNEL_TYPE] 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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.monitoring_v3.types.NotificationChannelDescriptor`	A description of a notification channel. The descriptor includes the properties of the channel and the set of labels or fields that must be specified to configure channels of a given type.

get_notification_channel_verification_code

get_notification_channel_verification_code(request: Optional[Union[google.cloud.monitoring_v3.types.notification_service.GetNotificationChannelVerificationCodeRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Requests a verification code for an already verified channel that can then be used in a call to VerifyNotificationChannel() on a different channel with an equivalent identity in the same or in a different project. This makes it possible to copy a channel between projects without requiring manual reverification of the channel. If the channel is not in the verified state, this method will fail (in other words, this may only be used if the SendNotificationChannelVerificationCode and VerifyNotificationChannel paths have already been used to put the given channel into the verified state).

There is no guarantee that the verification codes returned by this method will be of a similar structure or form as the ones that are delivered to the channel via SendNotificationChannelVerificationCode; while VerifyNotificationChannel() will recognize both the codes delivered via SendNotificationChannelVerificationCode() and returned from GetNotificationChannelVerificationCode(), it is typically the case that the verification codes delivered via SendNotificationChannelVerificationCode() will be shorter and also have a shorter expiration (e.g. codes such as "G-123456") whereas GetVerificationCode() will typically return a much longer, websafe base 64 encoded string that has a longer expiration time.

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.GetNotificationChannelVerificationCodeRequest, dict]` The request object. The `GetNotificationChannelVerificationCode` request.
`name`	`str` Required. The notification channel for which a verification code is to be generated and retrieved. This must name a channel that is already verified; if the specified channel is not verified, the request will fail. 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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.monitoring_v3.types.GetNotificationChannelVerificationCodeResponse`	The GetNotificationChannelVerificationCode request.

list_notification_channel_descriptors

list_notification_channel_descriptors(request: Optional[Union[google.cloud.monitoring_v3.types.notification_service.ListNotificationChannelDescriptorsRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added.

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.ListNotificationChannelDescriptorsRequest, dict]` The request object. The `ListNotificationChannelDescriptors` request.
`name`	`str` Required. The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is: :: projects/[PROJECT_ID_OR_NUMBER] Note that this `names https://cloud.google.com/monitoring/api/v3#project_name`__ the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the `GetNotificationChannelDescriptor][google.monitoring.v3.NotificationChannelService.GetNotificationChannelDescriptor]` operation, instead. 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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.monitoring_v3.services.notification_channel_service.pagers.ListNotificationChannelDescriptorsPager`	The ListNotificationChannelDescriptors response. Iterating over this object will yield results and resolve additional pages automatically.

list_notification_channels

list_notification_channels(request: Optional[Union[google.cloud.monitoring_v3.types.notification_service.ListNotificationChannelsRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists the notification channels that have been created for the project.

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.ListNotificationChannelsRequest, dict]` The request object. The `ListNotificationChannels` request.
`name`	`str` Required. The `project https://cloud.google.com/monitoring/api/v3#project_name`__ on which to execute the request. The format is: :: projects/[PROJECT_ID_OR_NUMBER] This names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the [`GetNotificationChannel`][google.monitoring.v3.NotificationChannelService.GetNotificationChannel] operation. 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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.monitoring_v3.services.notification_channel_service.pagers.ListNotificationChannelsPager`	The ListNotificationChannels response. Iterating over this object will yield results and resolve additional pages automatically.

notification_channel_descriptor_path

notification_channel_descriptor_path(project: str, channel_descriptor: str)

Returns a fully-qualified notification_channel_descriptor string.

notification_channel_path

notification_channel_path(project: str, notification_channel: str)

Returns a fully-qualified notification_channel string.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_notification_channel_descriptor_path

parse_notification_channel_descriptor_path(path: str)

Parses a notification_channel_descriptor path into its component segments.

parse_notification_channel_path

parse_notification_channel_path(path: str)

Parses a notification_channel path into its component segments.

send_notification_channel_verification_code

send_notification_channel_verification_code(request: Optional[Union[google.cloud.monitoring_v3.types.notification_service.SendNotificationChannelVerificationCodeRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Causes a verification code to be delivered to the channel. The code can then be supplied in VerifyNotificationChannel to verify the channel.

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.SendNotificationChannelVerificationCodeRequest, dict]` The request object. The `SendNotificationChannelVerificationCode` request.
`name`	`str` Required. The notification channel to which to send a verification code. 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, str]]` Strings which should be sent along with the request as metadata.

update_notification_channel

update_notification_channel(request: Optional[Union[google.cloud.monitoring_v3.types.notification_service.UpdateNotificationChannelRequest, dict]] = None, *, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, notification_channel: Optional[google.cloud.monitoring_v3.types.notification.NotificationChannel] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a notification channel. Fields not specified in the field mask remain unchanged.

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.UpdateNotificationChannelRequest, dict]` The request object. The `UpdateNotificationChannel` request.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` The fields to update. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`notification_channel`	`google.cloud.monitoring_v3.types.NotificationChannel` Required. A description of the changes to be applied to the specified notification channel. The description must provide a definition for fields to be updated; the names of these fields should also be included in the `update_mask`. This corresponds to the `notification_channel` 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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.monitoring_v3.types.NotificationChannel`	A NotificationChannel is a medium through which an alert is delivered when a policy violation is detected. Examples of channels include email, SMS, and third-party messaging applications. Fields containing sensitive information like authentication tokens or contact info are only partially populated on retrieval.

verify_notification_channel

verify_notification_channel(request: Optional[Union[google.cloud.monitoring_v3.types.notification_service.VerifyNotificationChannelRequest, dict]] = None, *, name: Optional[str] = None, code: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Verifies a NotificationChannel by proving receipt of the code delivered to the channel as a result of calling SendNotificationChannelVerificationCode.

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.VerifyNotificationChannelRequest, dict]` The request object. The `VerifyNotificationChannel` request.
`name`	`str` Required. The notification channel to verify. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`code`	`str` Required. The verification code that was delivered to the channel as a result of invoking the `SendNotificationChannelVerificationCode` API method or that was retrieved from a verified channel via `GetNotificationChannelVerificationCode`. For example, one might have "G-123456" or "TKNZGhhd2EyN3I1MnRnMjRv" (in general, one is only guaranteed that the code is valid UTF-8; one should not make any assumptions regarding the structure or format of the code). This corresponds to the `code` 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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.monitoring_v3.types.NotificationChannel`	A NotificationChannel is a medium through which an alert is delivered when a policy violation is detected. Examples of channels include email, SMS, and third-party messaging applications. Fields containing sensitive information like authentication tokens or contact info are only partially populated on retrieval.