async def get_group(
self,
request: group_service.GetGroupRequest = None,
*,
name: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> group.Group:
r"""Gets a single group.
Args:
request (:class:`google.cloud.monitoring_v3.types.GetGroupRequest`):
The request object. The `GetGroup` request.
name (:class:`str`):
Required. The group to retrieve. The format is:
::
projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_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:
google.cloud.monitoring_v3.types.Group:
The description of a dynamic collection of monitored resources. Each group
has a filter that is matched against monitored
resources and their associated metadata. If a group's
filter matches an available monitored resource, then
that resource is a member of that group. Groups can
contain any number of monitored resources, and each
monitored resource can be a member of any number of
groups.
Groups can be nested in parent-child hierarchies. The
parentName field identifies an optional parent for
each group. If a group has a parent, then the only
monitored resources available to be matched by the
group's filter are the resources contained in the
parent group. In other words, a group contains the
monitored resources that match its filter and the
filters of all the group's ancestors. A group without
a parent can contain any monitored resource.
For example, consider an infrastructure running a set
of instances with two user-defined tags:
"environment" and "role". A parent group has a
filter, environment="production". A child of that
parent group has a filter, role="transcoder". The
parent group contains all instances in the production
environment, regardless of their roles. The child
group contains instances that have the transcoder
role *and* are in the production environment.
The monitored resources contained in a group can
change at any moment, depending on what resources
exist and what filters are associated with the group
and its ancestors.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([name])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
request = group_service.GetGroupRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.get_group,
default_retry=retries.Retry(
initial=0.1,
maximum=30.0,
multiplier=1.3,
predicate=retries.if_exception_type(
core_exceptions.DeadlineExceeded,
core_exceptions.ServiceUnavailable,
),
deadline=30.0,
),
default_timeout=30.0,
client_info=DEFAULT_CLIENT_INFO,
)
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Send the request.
response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
def get_group(
self,
request: group_service.GetGroupRequest = None,
*,
name: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> group.Group:
r"""Gets a single group.
Args:
request (:class:`~.group_service.GetGroupRequest`):
The request object. The `GetGroup` request.
name (:class:`str`):
Required. The group to retrieve. The format is:
::
projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_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:
~.group.Group:
The description of a dynamic collection of monitored
resources. Each group has a filter that is matched
against monitored resources and their associated
metadata. If a group's filter matches an available
monitored resource, then that resource is a member of
that group. Groups can contain any number of monitored
resources, and each monitored resource can be a member
of any number of groups.
Groups can be nested in parent-child hierarchies. The
``parentName`` field identifies an optional parent for
each group. If a group has a parent, then the only
monitored resources available to be matched by the
group's filter are the resources contained in the parent
group. In other words, a group contains the monitored
resources that match its filter and the filters of all
the group's ancestors. A group without a parent can
contain any monitored resource.
For example, consider an infrastructure running a set of
instances with two user-defined tags: ``"environment"``
and ``"role"``. A parent group has a filter,
``environment="production"``. A child of that parent
group has a filter, ``role="transcoder"``. The parent
group contains all instances in the production
environment, regardless of their roles. The child group
contains instances that have the transcoder role *and*
are in the production environment.
The monitored resources contained in a group can change
at any moment, depending on what resources exist and
what filters are associated with the group and its
ancestors.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([name])
if request is not None and has_flattened_params:
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
# Minor optimization to avoid making a copy if the user passes
# in a group_service.GetGroupRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, group_service.GetGroupRequest):
request = group_service.GetGroupRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.get_group]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("name", request.name), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
