Class MetricServiceClient (2.1.0)

MetricServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.monitoring_v3.services.metric_service.transports.base.MetricServiceTransport]] = None, 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 metric descriptors, monitored resource descriptors, and time series data.

Properties

transport

Return the transport used by the client instance.

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

Methods

MetricServiceClient

MetricServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.monitoring_v3.services.metric_service.transports.base.MetricServiceTransport]] = None, 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>)

Instantiate the metric 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, .MetricServiceTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`client_options_lib.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.
`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.

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)

Return a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Return a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Return a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Return a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Return a fully-qualified project string.

create_metric_descriptor

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

Creates a new metric descriptor. User-created metric descriptors define custom metrics <https://cloud.google.com/monitoring/custom-metrics>__.

Parameters
Name	Description
`request`	`.metric_service.CreateMetricDescriptorRequest` The request object. The `CreateMetricDescriptor` 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.
`metric_descriptor`	`.ga_metric.MetricDescriptor` Required. The new `custom metric https://cloud.google.com/monitoring/custom-metrics`__ 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
Type	Description
`.ga_metric.MetricDescriptor`	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.

create_time_series

create_time_series(request: Optional[google.cloud.monitoring_v3.types.metric_service.CreateTimeSeriesRequest] = None, *, name: Optional[str] = None, time_series: Optional[Sequence[google.cloud.monitoring_v3.types.metric.TimeSeries]] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameters
Name	Description
`request`	`.metric_service.CreateTimeSeriesRequest` 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`	`:class:Sequence[.gm_metric.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

delete_metric_descriptor(request: Optional[google.cloud.monitoring_v3.types.metric_service.DeleteMetricDescriptorRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a metric descriptor. Only user-created custom metrics <https://cloud.google.com/monitoring/custom-metrics>__ can be deleted.

Parameters
Name	Description
`request`	`.metric_service.DeleteMetricDescriptorRequest` 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.

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
`{@api.name}`	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
`{@api.name}`	The constructed client.

get_metric_descriptor

get_metric_descriptor(request: Optional[google.cloud.monitoring_v3.types.metric_service.GetMetricDescriptorRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a single metric descriptor. This method does not require a Workspace.

Parameters
Name	Description
`request`	`.metric_service.GetMetricDescriptorRequest` 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
Type	Description
`.ga_metric.MetricDescriptor`	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.

get_monitored_resource_descriptor

get_monitored_resource_descriptor(request: Optional[google.cloud.monitoring_v3.types.metric_service.GetMonitoredResourceDescriptorRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a single monitored resource descriptor. This method does not require a Workspace.

Parameters
Name	Description
`request`	`.metric_service.GetMonitoredResourceDescriptorRequest` 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

Type Description

.monitored_resource.MonitoredResourceDescriptor 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.

list_metric_descriptors

list_metric_descriptors(request: Optional[google.cloud.monitoring_v3.types.metric_service.ListMetricDescriptorsRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists metric descriptors that match a filter. This method does not require a Workspace.

Parameters
Name	Description
`request`	`.metric_service.ListMetricDescriptorsRequest` 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
Type	Description
`.pagers.ListMetricDescriptorsPager`	The `ListMetricDescriptors` response. Iterating over this object will yield results and resolve additional pages automatically.

list_monitored_resource_descriptors

list_monitored_resource_descriptors(request: Optional[google.cloud.monitoring_v3.types.metric_service.ListMonitoredResourceDescriptorsRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists monitored resource descriptors that match a filter. This method does not require a Workspace.

Parameters
Name	Description
`request`	`.metric_service.ListMonitoredResourceDescriptorsRequest` 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
Type	Description
`.pagers.ListMonitoredResourceDescriptorsPager`	The `ListMonitoredResourceDescriptors` response. Iterating over this object will yield results and resolve additional pages automatically.

list_time_series

list_time_series(request: Optional[google.cloud.monitoring_v3.types.metric_service.ListTimeSeriesRequest] = 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: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists time series that match a filter. This method does not require a Workspace.

Parameters
Name	Description
`request`	`.metric_service.ListTimeSeriesRequest` The request object. The `ListTimeSeries` 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.
`filter`	`str` Required. A `monitoring filter https://cloud.google.com/monitoring/api/v3/filters`__ 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`	`.common.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`	`.metric_service.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
Type	Description
`.pagers.ListTimeSeriesPager`	The `ListTimeSeries` response. Iterating over this object will yield results and resolve additional pages automatically.

monitored_resource_descriptor_path

monitored_resource_descriptor_path(
    project: str, monitored_resource_descriptor: str
)

Return a fully-qualified monitored_resource_descriptor 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_monitored_resource_descriptor_path

parse_monitored_resource_descriptor_path(path: str)

Parse a monitored_resource_descriptor path into its component segments.