def delete_notification_channel(
self,
name,
force=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None):
"""
Deletes a notification channel.
Example:
>>> from google.cloud import monitoring_v3
>>>
>>> client = monitoring_v3.NotificationChannelServiceClient()
>>>
>>> name = client.notification_channel_path('[PROJECT]', '[NOTIFICATION_CHANNEL]')
>>>
>>> client.delete_notification_channel(name)
Args:
name (str): The channel for which to execute the request. The format is
``projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]``.
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.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
timeout (Optional[float]): The amount of time, in seconds, to wait
for the request to complete. Note that if ``retry`` is
specified, the timeout applies to each individual attempt.
metadata (Optional[Sequence[Tuple[str, str]]]): Additional metadata
that is provided to the method.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request
failed for any reason.
google.api_core.exceptions.RetryError: If the request failed due
to a retryable error and retry attempts failed.
ValueError: If the parameters are invalid.
"""
if metadata is None:
metadata = []
metadata = list(metadata)
request = notification_service_pb2.DeleteNotificationChannelRequest(
name=name,
force=force,
)
self._delete_notification_channel(
request, retry=retry, timeout=timeout, metadata=metadata)
def test_delete_notification_channel(self):
channel = ChannelStub()
client = monitoring_v3.NotificationChannelServiceClient(
channel=channel)
# Setup Request
name = client.notification_channel_path('[PROJECT]',
'[NOTIFICATION_CHANNEL]')
client.delete_notification_channel(name)
assert len(channel.requests) == 1
expected_request = notification_service_pb2.DeleteNotificationChannelRequest(
name=name)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def test_delete_notification_channel(self):
channel = ChannelStub()
patch = mock.patch("google.api_core.grpc_helpers.create_channel")
with patch as create_channel:
create_channel.return_value = channel
client = monitoring_v3.NotificationChannelServiceClient()
# Setup Request
name = client.notification_channel_path("[PROJECT]",
"[NOTIFICATION_CHANNEL]")
client.delete_notification_channel(name)
assert len(channel.requests) == 1
expected_request = notification_service_pb2.DeleteNotificationChannelRequest(
name=name)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
