Class GroupServiceAsyncClient (2.9.2)

GroupServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.monitoring_v3.services.group_service.transports.base.GroupServiceTransport] = 'grpc_asyncio', 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 Group API lets you inspect and manage your groups <#google.monitoring.v3.Group>__.

A group is a named filter that is used to identify a collection of monitored resources. Groups are typically used to mirror the physical and/or logical topology of the environment. Because group membership is computed dynamically, monitored resources that are started in the future are automatically placed in matching groups. By using a group to name monitored resources in, for example, an alert policy, the target of that alert policy is updated automatically as monitored resources are added and removed from the infrastructure.

Properties

transport

Returns the transport used by the client instance.

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

Methods

GroupServiceAsyncClient

GroupServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.monitoring_v3.services.group_service.transports.base.GroupServiceTransport] = 'grpc_asyncio', 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 group 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, .GroupServiceTransport]` The transport to use. If set to None, a transport is chosen automatically.
`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.

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

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_group

create_group(request: Optional[Union[google.cloud.monitoring_v3.types.group_service.CreateGroupRequest, dict]] = None, *, name: Optional[str] = None, group: Optional[google.cloud.monitoring_v3.types.group.Group] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new group.

from google.cloud import monitoring_v3

async def sample_create_group():
    # Create a client
    client = monitoring_v3.GroupServiceAsyncClient()

    # Initialize request argument(s)
    request = monitoring_v3.CreateGroupRequest(
        name="name_value",
    )

    # Make the request
    response = await client.create_group(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.CreateGroupRequest, dict]` The request object. The `CreateGroup` request.
`name`	`str` Required. The `project https://cloud.google.com/monitoring/api/v3#project_name`__ in which to create the group. The format is: :: projects/[PROJECT_ID_OR_NUMBER] This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`group`	`Group` Required. A group definition. It is an error to define the `name` field because the system assigns the name. This corresponds to the `group` 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.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.

delete_group

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

Deletes an existing group.

from google.cloud import monitoring_v3

async def sample_delete_group():
    # Create a client
    client = monitoring_v3.GroupServiceAsyncClient()

    # Initialize request argument(s)
    request = monitoring_v3.DeleteGroupRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_group(request=request)

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.DeleteGroupRequest, dict]` The request object. The `DeleteGroup` request. The default behavior is to be able to delete a single group without any descendants.
`name`	`str` Required. The group to delete. 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.

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

get_group

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

Gets a single group.

from google.cloud import monitoring_v3

async def sample_get_group():
    # Create a client
    client = monitoring_v3.GroupServiceAsyncClient()

    # Initialize request argument(s)
    request = monitoring_v3.GetGroupRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_group(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.GetGroupRequest, dict]` The request object. The `GetGroup` request.
`name`	`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

Type Description

get_mtls_endpoint_and_cert_source

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

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 variabel 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.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

group_path

group_path(project: str, group: str)

Returns a fully-qualified group string.

list_group_members

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

Lists the monitored resources that are members of a group.

from google.cloud import monitoring_v3

async def sample_list_group_members():
    # Create a client
    client = monitoring_v3.GroupServiceAsyncClient()

    # Initialize request argument(s)
    request = monitoring_v3.ListGroupMembersRequest(
        name="name_value",
    )

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.ListGroupMembersRequest, dict]` The request object. The `ListGroupMembers` request.
`name`	`str` Required. The group whose members are listed. 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
Type	Description
`google.cloud.monitoring_v3.services.group_service.pagers.ListGroupMembersAsyncPager`	The ListGroupMembers response. Iterating over this object will yield results and resolve additional pages automatically.

list_groups

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

Lists the existing groups.

from google.cloud import monitoring_v3

async def sample_list_groups():
    # Create a client
    client = monitoring_v3.GroupServiceAsyncClient()

    # Initialize request argument(s)
    request = monitoring_v3.ListGroupsRequest(
        children_of_group="children_of_group_value",
        name="name_value",
    )

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.ListGroupsRequest, dict]` The request object. The `ListGroup` request.
`name`	`str` Required. The `project https://cloud.google.com/monitoring/api/v3#project_name`__ whose groups are to be listed. The format is: :: projects/[PROJECT_ID_OR_NUMBER] 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.group_service.pagers.ListGroupsAsyncPager`	The ListGroups response. Iterating over this object will yield results and resolve additional pages automatically.

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_group_path

parse_group_path(path: str)

Parses a group path into its component segments.

update_group

update_group(request: Optional[Union[google.cloud.monitoring_v3.types.group_service.UpdateGroupRequest, dict]] = None, *, group: Optional[google.cloud.monitoring_v3.types.group.Group] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an existing group. You can change any group attributes except name.

from google.cloud import monitoring_v3

async def sample_update_group():
    # Create a client
    client = monitoring_v3.GroupServiceAsyncClient()

    # Initialize request argument(s)
    request = monitoring_v3.UpdateGroupRequest(
    )

    # Make the request
    response = await client.update_group(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.monitoring_v3.types.UpdateGroupRequest, dict]` The request object. The `UpdateGroup` request.
`group`	`Group` Required. The new definition of the group. All fields of the existing group, excepting `name`, are replaced with the corresponding fields of this group. This corresponds to the `group` 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