def delete_group(
self,
name,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Deletes an existing group.
Example:
>>> from google.cloud import monitoring_v3
>>>
>>> client = monitoring_v3.GroupServiceClient()
>>>
>>> name = client.group_path('[PROJECT]', '[GROUP]')
>>>
>>> client.delete_group(name)
Args:
name (str): The group to delete. The format is
``"projects/{project_id_or_number}/groups/{group_id}"``.
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)
# Wrap the transport method to add retry and timeout logic.
if "delete_group" not in self._inner_api_calls:
self._inner_api_calls[
"delete_group"] = google.api_core.gapic_v1.method.wrap_method(
self.transport.delete_group,
default_retry=self._method_configs["DeleteGroup"].retry,
default_timeout=self._method_configs["DeleteGroup"].
timeout,
client_info=self._client_info,
)
request = group_service_pb2.DeleteGroupRequest(name=name)
self._inner_api_calls["delete_group"](request,
retry=retry,
timeout=timeout,
metadata=metadata)
def test_delete_group(self):
channel = ChannelStub()
client = monitoring_v3.GroupServiceClient(channel=channel)
# Setup Request
name = client.group_path('[PROJECT]', '[GROUP]')
client.delete_group(name)
assert len(channel.requests) == 1
expected_request = group_service_pb2.DeleteGroupRequest(name=name)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def test_delete_group(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.GroupServiceClient()
# Setup Request
name = client.group_path("[PROJECT]", "[GROUP]")
client.delete_group(name)
assert len(channel.requests) == 1
expected_request = group_service_pb2.DeleteGroupRequest(name=name)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def delete_group(
self,
name,
recursive=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Deletes an existing group.
Example:
>>> from google.cloud import monitoring_v3
>>>
>>> client = monitoring_v3.GroupServiceClient()
>>>
>>> name = client.group_path('[PROJECT]', '[GROUP]')
>>>
>>> client.delete_group(name)
Args:
name (str): Required. The group to delete. The format is:
::
projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
recursive (bool): If this field is true, then the request means to delete a group with all
its descendants. Otherwise, the request means to delete a group only when
it has no descendants. The default value is false.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will
be retried using a default configuration.
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)
# Wrap the transport method to add retry and timeout logic.
if "delete_group" not in self._inner_api_calls:
self._inner_api_calls[
"delete_group"
] = google.api_core.gapic_v1.method.wrap_method(
self.transport.delete_group,
default_retry=self._method_configs["DeleteGroup"].retry,
default_timeout=self._method_configs["DeleteGroup"].timeout,
client_info=self._client_info,
)
request = group_service_pb2.DeleteGroupRequest(name=name, recursive=recursive)
if metadata is None:
metadata = []
metadata = list(metadata)
try:
routing_header = [("name", name)]
except AttributeError:
pass
else:
routing_metadata = google.api_core.gapic_v1.routing_header.to_grpc_metadata(
routing_header
)
metadata.append(routing_metadata)
self._inner_api_calls["delete_group"](
request, retry=retry, timeout=timeout, metadata=metadata
)
