Class MetricsScopesAsyncClient (1.2.2)

Stay organized with collections Save and categorize content based on your preferences.
MetricsScopesAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.transports.base.MetricsScopesTransport] = '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>)

Manages Cloud Monitoring Metrics Scopes, and the monitoring of Google Cloud projects and AWS accounts.

Inheritance

builtins.object > MetricsScopesAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
MetricsScopesTransportThe transport used by the client instance.

Methods

MetricsScopesAsyncClient

MetricsScopesAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.transports.base.MetricsScopesTransport] = '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 metrics scopes client.

Parameters
NameDescription
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, `.MetricsScopesTransport`]

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
TypeDescription
google.auth.exceptions.MutualTlsChannelErrorIf 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_monitored_project

create_monitored_project(request: Optional[Union[google.cloud.monitoring_metrics_scope_v1.types.metrics_scopes.CreateMonitoredProjectRequest, dict]] = None, *, parent: Optional[str] = None, monitored_project: Optional[google.cloud.monitoring_metrics_scope_v1.types.metrics_scope.MonitoredProject] = 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]] = ())

Adds a MonitoredProject with the given project ID to the specified Metrics Scope.

from google.cloud import monitoring_metrics_scope_v1

async def sample_create_monitored_project():
    # Create a client
    client = monitoring_metrics_scope_v1.MetricsScopesAsyncClient()

    # Initialize request argument(s)
    request = monitoring_metrics_scope_v1.CreateMonitoredProjectRequest(
        parent="parent_value",
    )

    # Make the request
    operation = client.create_monitored_project(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.monitoring_metrics_scope_v1.types.CreateMonitoredProjectRequest, dict]

The request object. Request for the CreateMonitoredProject method.

parent `str`

Required. The resource name of the existing Metrics Scope that will monitor this project. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

monitored_project MonitoredProject

Required. The initial MonitoredProject configuration. Specify only the monitored_project.name field. All other fields are ignored. The monitored_project.name must be in the format: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}/projects/{MONITORED_PROJECT_ID_OR_NUMBER} This corresponds to the monitored_project 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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be MonitoredProject A [project being monitored](\ https://cloud.google.com/monitoring/settings/multiple-projects#create-multi) by a Metrics Scope.

delete_monitored_project

delete_monitored_project(request: Optional[Union[google.cloud.monitoring_metrics_scope_v1.types.metrics_scopes.DeleteMonitoredProjectRequest, 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 a MonitoredProject from the specified Metrics Scope.

from google.cloud import monitoring_metrics_scope_v1

async def sample_delete_monitored_project():
    # Create a client
    client = monitoring_metrics_scope_v1.MetricsScopesAsyncClient()

    # Initialize request argument(s)
    request = monitoring_metrics_scope_v1.DeleteMonitoredProjectRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_monitored_project(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.monitoring_metrics_scope_v1.types.DeleteMonitoredProjectRequest, dict]

The request object. Request for the DeleteMonitoredProject method.

name `str`

Required. The resource name of the MonitoredProject. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}/projects/{MONITORED_PROJECT_ID_OR_NUMBER} Authorization requires the following Google IAM <https://cloud.google.com/iam>__ permissions on both the Metrics Scope and on the MonitoredProject: monitoring.metricsScopes.link 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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
MetricsScopesAsyncClientThe 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
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
MetricsScopesAsyncClientThe 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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
MetricsScopesAsyncClientThe constructed client.

get_metrics_scope

get_metrics_scope(request: Optional[Union[google.cloud.monitoring_metrics_scope_v1.types.metrics_scopes.GetMetricsScopeRequest, 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]] = ())

Returns a specific Metrics Scope.

from google.cloud import monitoring_metrics_scope_v1

async def sample_get_metrics_scope():
    # Create a client
    client = monitoring_metrics_scope_v1.MetricsScopesAsyncClient()

    # Initialize request argument(s)
    request = monitoring_metrics_scope_v1.GetMetricsScopeRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.monitoring_metrics_scope_v1.types.GetMetricsScopeRequest, dict]

The request object. Request for the GetMetricsScope method.

name `str`

Required. The resource name of the Metrics Scope. Example: locations/global/metricsScopes/{SCOPING_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
TypeDescription
google.cloud.monitoring_metrics_scope_v1.types.MetricsScopeRepresents a [Metrics Scope](\ https://cloud.google.com/monitoring/settings#concept-scope) in Cloud Monitoring, which specifies one or more Google projects and zero or more AWS accounts to monitor together.

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
NameDescription
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
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf any errors happen.
Returns
TypeDescription
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.

list_metrics_scopes_by_monitored_project

list_metrics_scopes_by_monitored_project(request: Optional[Union[google.cloud.monitoring_metrics_scope_v1.types.metrics_scopes.ListMetricsScopesByMonitoredProjectRequest, dict]] = 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]] = ())

Returns a list of every Metrics Scope that a specific MonitoredProject has been added to. The metrics scope representing the specified monitored project will always be the first entry in the response.

from google.cloud import monitoring_metrics_scope_v1

async def sample_list_metrics_scopes_by_monitored_project():
    # Create a client
    client = monitoring_metrics_scope_v1.MetricsScopesAsyncClient()

    # Initialize request argument(s)
    request = monitoring_metrics_scope_v1.ListMetricsScopesByMonitoredProjectRequest(
        monitored_resource_container="monitored_resource_container_value",
    )

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

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.monitoring_metrics_scope_v1.types.ListMetricsScopesByMonitoredProjectRequest, dict]

The request object. Request for the ListMetricsScopesByMonitoredProject method.

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
TypeDescription
google.cloud.monitoring_metrics_scope_v1.types.ListMetricsScopesByMonitoredProjectResponseResponse for the ListMetricsScopesByMonitoredProject method.

metrics_scope_path

metrics_scope_path(metrics_scope: str)

Returns a fully-qualified metrics_scope string.

monitored_project_path

monitored_project_path(metrics_scope: str, project: str)

Returns a fully-qualified monitored_project 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_metrics_scope_path

parse_metrics_scope_path(path: str)

Parses a metrics_scope path into its component segments.

parse_monitored_project_path

parse_monitored_project_path(path: str)

Parses a monitored_project path into its component segments.