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
Returns 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>)
Instantiates 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 |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
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 |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
create_metric_descriptor
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: 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 |
Union[google.cloud.monitoring_v3.types.CreateMetricDescriptorRequest, dict]
The request object. The |
name |
str
Required. The |
metric_descriptor |
google.api.metric_pb2.MetricDescriptor
Required. The new |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api.metric_pb2.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[Union[google.cloud.monitoring_v3.types.metric_service.CreateTimeSeriesRequest, dict]] = 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 |
Union[google.cloud.monitoring_v3.types.CreateTimeSeriesRequest, dict]
The request object. The |
name |
str
Required. The |
time_series |
Sequence[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 |
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[Union[google.cloud.monitoring_v3.types.metric_service.DeleteMetricDescriptorRequest, dict]] = 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 |
Union[google.cloud.monitoring_v3.types.DeleteMetricDescriptorRequest, dict]
The request object. The |
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 |
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 |
MetricServiceClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
MetricServiceClient | 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 |
MetricServiceClient | The constructed client. |
get_metric_descriptor
get_metric_descriptor(request: Optional[Union[google.cloud.monitoring_v3.types.metric_service.GetMetricDescriptorRequest, dict]] = 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 |
Union[google.cloud.monitoring_v3.types.GetMetricDescriptorRequest, dict]
The request object. The |
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 |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api.metric_pb2.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[Union[google.cloud.monitoring_v3.types.metric_service.GetMonitoredResourceDescriptorRequest, dict]] = 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 |
Union[google.cloud.monitoring_v3.types.GetMonitoredResourceDescriptorRequest, dict]
The request object. The |
name |
str
Required. The monitored resource descriptor to get. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE] The |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api.monitored_resource_pb2.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[Union[google.cloud.monitoring_v3.types.metric_service.ListMetricDescriptorsRequest, dict]] = 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 |
Union[google.cloud.monitoring_v3.types.ListMetricDescriptorsRequest, dict]
The request object. The |
name |
str
Required. The |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.monitoring_v3.services.metric_service.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[Union[google.cloud.monitoring_v3.types.metric_service.ListMonitoredResourceDescriptorsRequest, dict]] = 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 |
Union[google.cloud.monitoring_v3.types.ListMonitoredResourceDescriptorsRequest, dict]
The request object. The |
name |
str
Required. The |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.monitoring_v3.services.metric_service.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[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: 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 |
Union[google.cloud.monitoring_v3.types.ListTimeSeriesRequest, dict]
The request object. The |
name |
str
Required. The |
filter |
str
Required. A |
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 |
view |
google.cloud.monitoring_v3.types.ListTimeSeriesRequest.TimeSeriesView
Required. Specifies which information is returned about the time series. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.monitoring_v3.services.metric_service.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
)
Returns 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)
Parses a monitored_resource_descriptor path into its component segments.
parse_time_series_path
parse_time_series_path(path: str)
Parses a time_series path into its component segments.
time_series_path
time_series_path(project: str, time_series: str)
Returns a fully-qualified time_series string.