As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

MetricService

class google.cloud.monitoring_v3.services.metric_service.MetricServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.monitoring_v3.services.metric_service.transports.base.MetricServiceTransport, typing.Callable[[...], google.cloud.monitoring_v3.services.metric_service.transports.base.MetricServiceTransport]]] = 'grpc_asyncio', client_options: typing.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>)[source]

Manages metric descriptors, monitored resource descriptors, and time series data.

Instantiates the metric service async client.

Parameters

  • 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 (Optional[Union[str,MetricServiceTransport,Callable[..., MetricServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the MetricServiceTransport constructor. If set to None, a transport is chosen automatically.

  • client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –

    Custom options for the client.

    1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

    2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

    3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

  • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

static common_billing_account_path(billing_account: str) → str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str

Returns a fully-qualified location string.

static common_organization_path(organization: str) → str

Returns a fully-qualified organization string.

static common_project_path(project: str) → str

Returns a fully-qualified project string.

async create_metric_descriptor(request: Optional[Union[google.cloud.monitoring_v3.types.metric_service.CreateMetricDescriptorRequest, dict]] = None, *, name: Optional[str] = None, metric_descriptor: Optional[google.api.metric_pb2.MetricDescriptor] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api.metric_pb2.MetricDescriptor[source]

Creates a new metric descriptor. The creation is executed asynchronously. User-created metric descriptors define custom metrics. The metric descriptor is updated if it already exists, except that metric labels are never removed.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

async def sample_create_metric_descriptor():
    # Create a client
    client = monitoring_v3.MetricServiceAsyncClient()

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

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

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.monitoring_v3.types.CreateMetricDescriptorRequest, dict]]) – The request object. The CreateMetricDescriptor request.

  • name (str) –

    Required. The project on which to execute the request. The format is: 4 projects/[PROJECT_ID_OR_NUMBER]

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • metric_descriptor (google.api.metric_pb2.MetricDescriptor) –

    Required. The new custom metric descriptor.

    This corresponds to the metric_descriptor field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – 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

Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type’s existing data unusable.

Return type

google.api.metric_pb2.MetricDescriptor

async create_service_time_series(request: Optional[Union[google.cloud.monitoring_v3.types.metric_service.CreateTimeSeriesRequest, dict]] = None, *, name: Optional[str] = None, time_series: Optional[MutableSequence[google.cloud.monitoring_v3.types.metric.TimeSeries]] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Creates or adds data to one or more service time series. A service time series is a time series for a metric from a Google Cloud service. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response. This endpoint rejects writes to user-defined metrics. This method is only for use by Google Cloud services. Use [projects.timeSeries.create][google.monitoring.v3.MetricService.CreateTimeSeries] instead.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

async def sample_create_service_time_series():
    # Create a client
    client = monitoring_v3.MetricServiceAsyncClient()

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

    # Make the request
    await client.create_service_time_series(request=request)
Parameters

  • request (Optional[Union[google.cloud.monitoring_v3.types.CreateTimeSeriesRequest, dict]]) – The request object. The CreateTimeSeries request.

  • name (str) –

    Required. The project on which to execute the request. 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.

  • time_series (MutableSequence[google.cloud.monitoring_v3.types.TimeSeries]) –

    Required. The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.

    The maximum number of TimeSeries objects per Create request is 200.

    This corresponds to the time_series field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – 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.

async create_time_series(request: Optional[Union[google.cloud.monitoring_v3.types.metric_service.CreateTimeSeriesRequest, dict]] = None, *, name: Optional[str] = None, time_series: Optional[MutableSequence[google.cloud.monitoring_v3.types.metric.TimeSeries]] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response. This method does not support resource locations constraint of an organization policy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

async def sample_create_time_series():
    # Create a client
    client = monitoring_v3.MetricServiceAsyncClient()

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

    # Make the request
    await client.create_time_series(request=request)
Parameters

  • request (Optional[Union[google.cloud.monitoring_v3.types.CreateTimeSeriesRequest, dict]]) – The request object. The CreateTimeSeries request.

  • name (str) –

    Required. The project on which to execute the request. 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.

  • time_series (MutableSequence[google.cloud.monitoring_v3.types.TimeSeries]) –

    Required. The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.

    The maximum number of TimeSeries objects per Create request is 200.

    This corresponds to the time_series field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – 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.

async delete_metric_descriptor(request: Optional[Union[google.cloud.monitoring_v3.types.metric_service.DeleteMetricDescriptorRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Deletes a metric descriptor. Only user-created custom metrics can be deleted.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

async def sample_delete_metric_descriptor():
    # Create a client
    client = monitoring_v3.MetricServiceAsyncClient()

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

    # Make the request
    await client.delete_metric_descriptor(request=request)
Parameters

  • request (Optional[Union[google.cloud.monitoring_v3.types.DeleteMetricDescriptorRequest, dict]]) – The request object. The DeleteMetricDescriptor request.

  • name (str) –

    Required. The metric descriptor on which to execute the request. The format is:

    projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]

    An example of [METRIC_ID] is: "custom.googleapis.com/my_test_metric".

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – 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.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

MetricServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters

  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

MetricServiceAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

MetricServiceAsyncClient

async get_metric_descriptor(request: Optional[Union[google.cloud.monitoring_v3.types.metric_service.GetMetricDescriptorRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api.metric_pb2.MetricDescriptor[source]

Gets a single metric descriptor.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

async def sample_get_metric_descriptor():
    # Create a client
    client = monitoring_v3.MetricServiceAsyncClient()

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

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

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.monitoring_v3.types.GetMetricDescriptorRequest, dict]]) – The request object. The GetMetricDescriptor request.

  • name (str) –

    Required. The metric descriptor on which to execute the request. The format is:

    projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]

    An example value of [METRIC_ID] is "compute.googleapis.com/instance/disk/read_bytes_count".

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – 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

Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type’s existing data unusable.

Return type

google.api.metric_pb2.MetricDescriptor

async get_monitored_resource_descriptor(request: Optional[Union[google.cloud.monitoring_v3.types.metric_service.GetMonitoredResourceDescriptorRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api.monitored_resource_pb2.MonitoredResourceDescriptor[source]

Gets a single monitored resource descriptor.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

async def sample_get_monitored_resource_descriptor():
    # Create a client
    client = monitoring_v3.MetricServiceAsyncClient()

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

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

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.monitoring_v3.types.GetMonitoredResourceDescriptorRequest, dict]]) – The request object. The GetMonitoredResourceDescriptor request.

  • name (str) –

    Required. The monitored resource descriptor to get. The format is:

    projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE]

    The [RESOURCE_TYPE] is a predefined type, such as cloudsql_database.

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – 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

An object that describes the schema of a

[MonitoredResource][google.api.MonitoredResource] object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of “gce_instance” and specifies the use of the labels “instance_id” and “zone” to identify particular VM instances.

Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.

Return type

google.api.monitored_resource_pb2.MonitoredResourceDescriptor

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

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

Parameters

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.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.monitoring_v3.services.metric_service.transports.base.MetricServiceTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

async list_metric_descriptors(request: Optional[Union[google.cloud.monitoring_v3.types.metric_service.ListMetricDescriptorsRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.monitoring_v3.services.metric_service.pagers.ListMetricDescriptorsAsyncPager[source]

Lists metric descriptors that match a filter.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

async def sample_list_metric_descriptors():
    # Create a client
    client = monitoring_v3.MetricServiceAsyncClient()

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

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

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

  • request (Optional[Union[google.cloud.monitoring_v3.types.ListMetricDescriptorsRequest, dict]]) – The request object. The ListMetricDescriptors request.

  • name (str) –

    Required. The project on which to execute the request. 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_async.AsyncRetry) – 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

The ListMetricDescriptors response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.monitoring_v3.services.metric_service.pagers.ListMetricDescriptorsAsyncPager

async list_monitored_resource_descriptors(request: Optional[Union[google.cloud.monitoring_v3.types.metric_service.ListMonitoredResourceDescriptorsRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.monitoring_v3.services.metric_service.pagers.ListMonitoredResourceDescriptorsAsyncPager[source]

Lists monitored resource descriptors that match a filter.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

async def sample_list_monitored_resource_descriptors():
    # Create a client
    client = monitoring_v3.MetricServiceAsyncClient()

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

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

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

  • request (Optional[Union[google.cloud.monitoring_v3.types.ListMonitoredResourceDescriptorsRequest, dict]]) – The request object. The ListMonitoredResourceDescriptors request.

  • name (str) –

    Required. The project on which to execute the request. 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_async.AsyncRetry) – 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

The ListMonitoredResourceDescriptors response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.monitoring_v3.services.metric_service.pagers.ListMonitoredResourceDescriptorsAsyncPager

async list_time_series(request: Optional[Union[google.cloud.monitoring_v3.types.metric_service.ListTimeSeriesRequest, dict]] = None, *, name: Optional[str] = None, filter: Optional[str] = None, interval: Optional[google.cloud.monitoring_v3.types.common.TimeInterval] = None, view: Optional[google.cloud.monitoring_v3.types.metric_service.ListTimeSeriesRequest.TimeSeriesView] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.monitoring_v3.services.metric_service.pagers.ListTimeSeriesAsyncPager[source]

Lists time series that match a filter.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

async def sample_list_time_series():
    # Create a client
    client = monitoring_v3.MetricServiceAsyncClient()

    # Initialize request argument(s)
    request = monitoring_v3.ListTimeSeriesRequest(
        name="name_value",
        filter="filter_value",
        view="HEADERS",
    )

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

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

  • request (Optional[Union[google.cloud.monitoring_v3.types.ListTimeSeriesRequest, dict]]) – The request object. The ListTimeSeries request.

  • name (str) –

    Required. The project, organization or folder on which to execute the request. The format is:

    projects/[PROJECT_ID_OR_NUMBER]
organizations/[ORGANIZATION_ID]
folders/[FOLDER_ID]

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • filter (str) –

    Required. A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:

    metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
    metric.labels.instance_name = "my-instance-name"

    This corresponds to the filter field on the request instance; if request is provided, this should not be set.

  • interval (google.cloud.monitoring_v3.types.TimeInterval) –

    Required. The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response.

    This corresponds to the interval field on the request instance; if request is provided, this should not be set.

  • view (google.cloud.monitoring_v3.types.ListTimeSeriesRequest.TimeSeriesView) –

    Required. Specifies which information is returned about the time series.

    This corresponds to the view field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – 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

The ListTimeSeries response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.monitoring_v3.services.metric_service.pagers.ListTimeSeriesAsyncPager

static metric_descriptor_path(project: str, metric_descriptor: str) → str

Returns a fully-qualified metric_descriptor string.

static monitored_resource_descriptor_path(project: str, monitored_resource_descriptor: str) → str

Returns a fully-qualified monitored_resource_descriptor string.

static parse_common_billing_account_path(path: str) → Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]

Parse a project path into its component segments.

static parse_metric_descriptor_path(path: str) → Dict[str, str]

Parses a metric_descriptor path into its component segments.

static parse_monitored_resource_descriptor_path(path: str) → Dict[str, str]

Parses a monitored_resource_descriptor path into its component segments.

static parse_time_series_path(path: str) → Dict[str, str]

Parses a time_series path into its component segments.

static time_series_path(project: str, time_series: str) → str

Returns a fully-qualified time_series string.

property transport: google.cloud.monitoring_v3.services.metric_service.transports.base.MetricServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

MetricServiceTransport

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used

by the client instance.

Return type

str

class google.cloud.monitoring_v3.services.metric_service.MetricServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.monitoring_v3.services.metric_service.transports.base.MetricServiceTransport, typing.Callable[[...], google.cloud.monitoring_v3.services.metric_service.transports.base.MetricServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Manages metric descriptors, monitored resource descriptors, and time series data.

Instantiates the metric service client.

Parameters

  • 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 (Optional[Union[str,MetricServiceTransport,Callable[..., MetricServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the MetricServiceTransport constructor. If set to None, a transport is chosen automatically.

  • client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –

    Custom options for the client.

    1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

    2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

    3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

  • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

static common_billing_account_path(billing_account: str) → str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]

Returns a fully-qualified project string.

create_metric_descriptor(request: Optional[Union[google.cloud.monitoring_v3.types.metric_service.CreateMetricDescriptorRequest, dict]] = None, *, name: Optional[str] = None, metric_descriptor: Optional[google.api.metric_pb2.MetricDescriptor] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api.metric_pb2.MetricDescriptor[source]

Creates a new metric descriptor. The creation is executed asynchronously. User-created metric descriptors define custom metrics. The metric descriptor is updated if it already exists, except that metric labels are never removed.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

def sample_create_metric_descriptor():
    # Create a client
    client = monitoring_v3.MetricServiceClient()

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

    # Make the request
    response = client.create_metric_descriptor(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.monitoring_v3.types.CreateMetricDescriptorRequest, dict]) – The request object. The CreateMetricDescriptor request.

  • name (str) –

    Required. The project on which to execute the request. The format is: 4 projects/[PROJECT_ID_OR_NUMBER]

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • metric_descriptor (google.api.metric_pb2.MetricDescriptor) –

    Required. The new custom metric descriptor.

    This corresponds to the metric_descriptor 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

Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type’s existing data unusable.

Return type

google.api.metric_pb2.MetricDescriptor

create_service_time_series(request: Optional[Union[google.cloud.monitoring_v3.types.metric_service.CreateTimeSeriesRequest, dict]] = None, *, name: Optional[str] = None, time_series: Optional[MutableSequence[google.cloud.monitoring_v3.types.metric.TimeSeries]] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Creates or adds data to one or more service time series. A service time series is a time series for a metric from a Google Cloud service. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response. This endpoint rejects writes to user-defined metrics. This method is only for use by Google Cloud services. Use [projects.timeSeries.create][google.monitoring.v3.MetricService.CreateTimeSeries] instead.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

def sample_create_service_time_series():
    # Create a client
    client = monitoring_v3.MetricServiceClient()

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

    # Make the request
    client.create_service_time_series(request=request)
Parameters

  • request (Union[google.cloud.monitoring_v3.types.CreateTimeSeriesRequest, dict]) – The request object. The CreateTimeSeries request.

  • name (str) –

    Required. The project on which to execute the request. 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.

  • time_series (MutableSequence[google.cloud.monitoring_v3.types.TimeSeries]) –

    Required. The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.

    The maximum number of TimeSeries objects per Create request is 200.

    This corresponds to the time_series 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.

create_time_series(request: Optional[Union[google.cloud.monitoring_v3.types.metric_service.CreateTimeSeriesRequest, dict]] = None, *, name: Optional[str] = None, time_series: Optional[MutableSequence[google.cloud.monitoring_v3.types.metric.TimeSeries]] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response. This method does not support resource locations constraint of an organization policy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

def sample_create_time_series():
    # Create a client
    client = monitoring_v3.MetricServiceClient()

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

    # Make the request
    client.create_time_series(request=request)
Parameters

  • request (Union[google.cloud.monitoring_v3.types.CreateTimeSeriesRequest, dict]) – The request object. The CreateTimeSeries request.

  • name (str) –

    Required. The project on which to execute the request. 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.

  • time_series (MutableSequence[google.cloud.monitoring_v3.types.TimeSeries]) –

    Required. The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.

    The maximum number of TimeSeries objects per Create request is 200.

    This corresponds to the time_series 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.

delete_metric_descriptor(request: Optional[Union[google.cloud.monitoring_v3.types.metric_service.DeleteMetricDescriptorRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Deletes a metric descriptor. Only user-created custom metrics can be deleted.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

def sample_delete_metric_descriptor():
    # Create a client
    client = monitoring_v3.MetricServiceClient()

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

    # Make the request
    client.delete_metric_descriptor(request=request)
Parameters

  • request (Union[google.cloud.monitoring_v3.types.DeleteMetricDescriptorRequest, dict]) – The request object. The DeleteMetricDescriptor request.

  • name (str) –

    Required. The metric descriptor on which to execute the request. The format is:

    projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]

    An example of [METRIC_ID] is: "custom.googleapis.com/my_test_metric".

    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.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

MetricServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters

  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

MetricServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

MetricServiceClient

get_metric_descriptor(request: Optional[Union[google.cloud.monitoring_v3.types.metric_service.GetMetricDescriptorRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api.metric_pb2.MetricDescriptor[source]

Gets a single metric descriptor.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

def sample_get_metric_descriptor():
    # Create a client
    client = monitoring_v3.MetricServiceClient()

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

    # Make the request
    response = client.get_metric_descriptor(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.monitoring_v3.types.GetMetricDescriptorRequest, dict]) – The request object. The GetMetricDescriptor request.

  • name (str) –

    Required. The metric descriptor on which to execute the request. The format is:

    projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]

    An example value of [METRIC_ID] is "compute.googleapis.com/instance/disk/read_bytes_count".

    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

Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type’s existing data unusable.

Return type

google.api.metric_pb2.MetricDescriptor

get_monitored_resource_descriptor(request: Optional[Union[google.cloud.monitoring_v3.types.metric_service.GetMonitoredResourceDescriptorRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api.monitored_resource_pb2.MonitoredResourceDescriptor[source]

Gets a single monitored resource descriptor.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

def sample_get_monitored_resource_descriptor():
    # Create a client
    client = monitoring_v3.MetricServiceClient()

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

    # Make the request
    response = client.get_monitored_resource_descriptor(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.monitoring_v3.types.GetMonitoredResourceDescriptorRequest, dict]) – The request object. The GetMonitoredResourceDescriptor request.

  • name (str) –

    Required. The monitored resource descriptor to get. The format is:

    projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE]

    The [RESOURCE_TYPE] is a predefined type, such as cloudsql_database.

    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

An object that describes the schema of a

[MonitoredResource][google.api.MonitoredResource] object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of “gce_instance” and specifies the use of the labels “instance_id” and “zone” to identify particular VM instances.

Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.

Return type

google.api.monitored_resource_pb2.MonitoredResourceDescriptor

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

Deprecated. 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 variable 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.

Parameters

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.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

list_metric_descriptors(request: Optional[Union[google.cloud.monitoring_v3.types.metric_service.ListMetricDescriptorsRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.monitoring_v3.services.metric_service.pagers.ListMetricDescriptorsPager[source]

Lists metric descriptors that match a filter.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

def sample_list_metric_descriptors():
    # Create a client
    client = monitoring_v3.MetricServiceClient()

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

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

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

  • request (Union[google.cloud.monitoring_v3.types.ListMetricDescriptorsRequest, dict]) – The request object. The ListMetricDescriptors request.

  • name (str) –

    Required. The project on which to execute the request. 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

The ListMetricDescriptors response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.monitoring_v3.services.metric_service.pagers.ListMetricDescriptorsPager

list_monitored_resource_descriptors(request: Optional[Union[google.cloud.monitoring_v3.types.metric_service.ListMonitoredResourceDescriptorsRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.monitoring_v3.services.metric_service.pagers.ListMonitoredResourceDescriptorsPager[source]

Lists monitored resource descriptors that match a filter.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

def sample_list_monitored_resource_descriptors():
    # Create a client
    client = monitoring_v3.MetricServiceClient()

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

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

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

  • request (Union[google.cloud.monitoring_v3.types.ListMonitoredResourceDescriptorsRequest, dict]) – The request object. The ListMonitoredResourceDescriptors request.

  • name (str) –

    Required. The project on which to execute the request. 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

The ListMonitoredResourceDescriptors response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.monitoring_v3.services.metric_service.pagers.ListMonitoredResourceDescriptorsPager

list_time_series(request: Optional[Union[google.cloud.monitoring_v3.types.metric_service.ListTimeSeriesRequest, dict]] = None, *, name: Optional[str] = None, filter: Optional[str] = None, interval: Optional[google.cloud.monitoring_v3.types.common.TimeInterval] = None, view: Optional[google.cloud.monitoring_v3.types.metric_service.ListTimeSeriesRequest.TimeSeriesView] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.monitoring_v3.services.metric_service.pagers.ListTimeSeriesPager[source]

Lists time series that match a filter.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3

def sample_list_time_series():
    # Create a client
    client = monitoring_v3.MetricServiceClient()

    # Initialize request argument(s)
    request = monitoring_v3.ListTimeSeriesRequest(
        name="name_value",
        filter="filter_value",
        view="HEADERS",
    )

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

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

  • request (Union[google.cloud.monitoring_v3.types.ListTimeSeriesRequest, dict]) – The request object. The ListTimeSeries request.

  • name (str) –

    Required. The project, organization or folder on which to execute the request. The format is:

    projects/[PROJECT_ID_OR_NUMBER]
organizations/[ORGANIZATION_ID]
folders/[FOLDER_ID]

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • filter (str) –

    Required. A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:

    metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
    metric.labels.instance_name = "my-instance-name"

    This corresponds to the filter field on the request instance; if request is provided, this should not be set.

  • interval (google.cloud.monitoring_v3.types.TimeInterval) –

    Required. The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response.

    This corresponds to the interval field on the request instance; if request is provided, this should not be set.

  • view (google.cloud.monitoring_v3.types.ListTimeSeriesRequest.TimeSeriesView) –

    Required. Specifies which information is returned about the time series.

    This corresponds to the view 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

The ListTimeSeries response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.monitoring_v3.services.metric_service.pagers.ListTimeSeriesPager

static metric_descriptor_path(project: str, metric_descriptor: str) → str[source]

Returns a fully-qualified metric_descriptor string.

static monitored_resource_descriptor_path(project: str, monitored_resource_descriptor: str) → str[source]

Returns a fully-qualified monitored_resource_descriptor string.

static parse_common_billing_account_path(path: str) → Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]

Parse a project path into its component segments.

static parse_metric_descriptor_path(path: str) → Dict[str, str][source]

Parses a metric_descriptor path into its component segments.

static parse_monitored_resource_descriptor_path(path: str) → Dict[str, str][source]

Parses a monitored_resource_descriptor path into its component segments.

static parse_time_series_path(path: str) → Dict[str, str][source]

Parses a time_series path into its component segments.

static time_series_path(project: str, time_series: str) → str[source]

Returns a fully-qualified time_series string.

property transport: google.cloud.monitoring_v3.services.metric_service.transports.base.MetricServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

MetricServiceTransport

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used by the client instance.

Return type

str

class google.cloud.monitoring_v3.services.metric_service.pagers.ListMetricDescriptorsAsyncPager(method: Callable[[...], Awaitable[google.cloud.monitoring_v3.types.metric_service.ListMetricDescriptorsResponse]], request: google.cloud.monitoring_v3.types.metric_service.ListMetricDescriptorsRequest, response: google.cloud.monitoring_v3.types.metric_service.ListMetricDescriptorsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_metric_descriptors requests.

This class thinly wraps an initial google.cloud.monitoring_v3.types.ListMetricDescriptorsResponse object, and provides an __aiter__ method to iterate through its metric_descriptors field.

If there are more pages, the __aiter__ method will make additional ListMetricDescriptors requests and continue to iterate through the metric_descriptors field on the corresponding responses.

All the usual google.cloud.monitoring_v3.types.ListMetricDescriptorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.monitoring_v3.services.metric_service.pagers.ListMetricDescriptorsPager(method: Callable[[...], google.cloud.monitoring_v3.types.metric_service.ListMetricDescriptorsResponse], request: google.cloud.monitoring_v3.types.metric_service.ListMetricDescriptorsRequest, response: google.cloud.monitoring_v3.types.metric_service.ListMetricDescriptorsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_metric_descriptors requests.

This class thinly wraps an initial google.cloud.monitoring_v3.types.ListMetricDescriptorsResponse object, and provides an __iter__ method to iterate through its metric_descriptors field.

If there are more pages, the __iter__ method will make additional ListMetricDescriptors requests and continue to iterate through the metric_descriptors field on the corresponding responses.

All the usual google.cloud.monitoring_v3.types.ListMetricDescriptorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.monitoring_v3.services.metric_service.pagers.ListMonitoredResourceDescriptorsAsyncPager(method: Callable[[...], Awaitable[google.cloud.monitoring_v3.types.metric_service.ListMonitoredResourceDescriptorsResponse]], request: google.cloud.monitoring_v3.types.metric_service.ListMonitoredResourceDescriptorsRequest, response: google.cloud.monitoring_v3.types.metric_service.ListMonitoredResourceDescriptorsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_monitored_resource_descriptors requests.

This class thinly wraps an initial google.cloud.monitoring_v3.types.ListMonitoredResourceDescriptorsResponse object, and provides an __aiter__ method to iterate through its resource_descriptors field.

If there are more pages, the __aiter__ method will make additional ListMonitoredResourceDescriptors requests and continue to iterate through the resource_descriptors field on the corresponding responses.

All the usual google.cloud.monitoring_v3.types.ListMonitoredResourceDescriptorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.monitoring_v3.services.metric_service.pagers.ListMonitoredResourceDescriptorsPager(method: Callable[[...], google.cloud.monitoring_v3.types.metric_service.ListMonitoredResourceDescriptorsResponse], request: google.cloud.monitoring_v3.types.metric_service.ListMonitoredResourceDescriptorsRequest, response: google.cloud.monitoring_v3.types.metric_service.ListMonitoredResourceDescriptorsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_monitored_resource_descriptors requests.

This class thinly wraps an initial google.cloud.monitoring_v3.types.ListMonitoredResourceDescriptorsResponse object, and provides an __iter__ method to iterate through its resource_descriptors field.

If there are more pages, the __iter__ method will make additional ListMonitoredResourceDescriptors requests and continue to iterate through the resource_descriptors field on the corresponding responses.

All the usual google.cloud.monitoring_v3.types.ListMonitoredResourceDescriptorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.monitoring_v3.services.metric_service.pagers.ListTimeSeriesAsyncPager(method: Callable[[...], Awaitable[google.cloud.monitoring_v3.types.metric_service.ListTimeSeriesResponse]], request: google.cloud.monitoring_v3.types.metric_service.ListTimeSeriesRequest, response: google.cloud.monitoring_v3.types.metric_service.ListTimeSeriesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_time_series requests.

This class thinly wraps an initial google.cloud.monitoring_v3.types.ListTimeSeriesResponse object, and provides an __aiter__ method to iterate through its time_series field.

If there are more pages, the __aiter__ method will make additional ListTimeSeries requests and continue to iterate through the time_series field on the corresponding responses.

All the usual google.cloud.monitoring_v3.types.ListTimeSeriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.monitoring_v3.services.metric_service.pagers.ListTimeSeriesPager(method: Callable[[...], google.cloud.monitoring_v3.types.metric_service.ListTimeSeriesResponse], request: google.cloud.monitoring_v3.types.metric_service.ListTimeSeriesRequest, response: google.cloud.monitoring_v3.types.metric_service.ListTimeSeriesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_time_series requests.

This class thinly wraps an initial google.cloud.monitoring_v3.types.ListTimeSeriesResponse object, and provides an __iter__ method to iterate through its time_series field.

If there are more pages, the __iter__ method will make additional ListTimeSeries requests and continue to iterate through the time_series field on the corresponding responses.

All the usual google.cloud.monitoring_v3.types.ListTimeSeriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters