Class MetricsServiceV2Client (1.14.0)

Version 1.14.0

• 3.11.3 (latest)
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.1
• 3.2.5
• 3.1.2
• 3.0.0
• 2.7.2
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.1
• 2.2.0
• 2.1.1
• 2.0.2
• 1.15.3
• 1.14.0
• 1.13.0
• 1.12.1

MetricsServiceV2Client(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Service for configuring logs-based metrics.

Methods

MetricsServiceV2Client

MetricsServiceV2Client(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Constructor.

Parameters
Name	Description
channel	grpc.Channel DEPRECATED. A Channel instance through which to make calls. This argument is mutually exclusive with credentials; providing both will raise an exception.
credentials	google.auth.credentials.Credentials The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to transport; doing so will raise an exception.
client_config	dict DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is 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.
client_options	Union[dict, google.api_core.client_options.ClientOptions] Client options used to set user options on the client. API Endpoint should be set through client_options.

billing_path

billing_path(billing_account)

Return a fully-qualified billing string.

create_log_metric

create_log_metric(parent, metric, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Creates a logs-based metric.

.. rubric:: Example

from google.cloud import logging_v2

client = logging_v2.MetricsServiceV2Client()

parent = client.project_path('[PROJECT]')

TODO: Initialize metric:

metric = {}

response = client.create_log_metric(parent, metric)

Parameters
Name	Description
parent	str The resource name of the project in which to create the metric: :: "projects/[PROJECT_ID]" The new metric must be provided in the request.
metric	Union[dict, LogMetric] The new logs-based metric, which must not have an identifier that already exists. If a dict is provided, it must be of the same form as the protobuf message LogMetric
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

delete_log_metric

delete_log_metric(metric_name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Deletes a logs-based metric.

.. rubric:: Example

from google.cloud import logging_v2

client = logging_v2.MetricsServiceV2Client()

metric_name = client.metric_path('[PROJECT]', '[METRIC]')

client.delete_log_metric(metric_name)

Parameters
Name	Description
metric_name	str The resource name of the metric to delete: :: "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

folder_path

folder_path(folder)

Return a fully-qualified folder string.

from_service_account_file

from_service_account_file(filename, *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
MetricsServiceV2Client	The constructed client.

from_service_account_json

from_service_account_json(filename, *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
MetricsServiceV2Client	The constructed client.

get_log_metric

get_log_metric(metric_name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Gets a logs-based metric.

.. rubric:: Example

from google.cloud import logging_v2

client = logging_v2.MetricsServiceV2Client()

metric_name = client.metric_path('[PROJECT]', '[METRIC]')

response = client.get_log_metric(metric_name)

Parameters
Name	Description
metric_name	str The resource name of the desired metric: :: "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

list_log_metrics

list_log_metrics(parent, page_size=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Lists logs-based metrics.

.. rubric:: Example

from google.cloud import logging_v2

client = logging_v2.MetricsServiceV2Client()

parent = client.project_path('[PROJECT]')

Iterate over all results

for element in client.list_log_metrics(parent): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.list_log_metrics(parent).pages: ... for element in page: ... # process element ... pass

Parameters
Name	Description
parent	str Required. The name of the project containing the metrics: :: "projects/[PROJECT_ID]"
page_size	int The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

metric_path

metric_path(project, metric)

Return a fully-qualified metric string.

organization_path

organization_path(organization)

Return a fully-qualified organization string.

project_path

project_path(project)

Return a fully-qualified project string.

update_log_metric

update_log_metric(metric_name, metric, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Creates or updates a logs-based metric.

.. rubric:: Example

from google.cloud import logging_v2

client = logging_v2.MetricsServiceV2Client()

metric_name = client.metric_path('[PROJECT]', '[METRIC]')

TODO: Initialize metric:

metric = {}

response = client.update_log_metric(metric_name, metric)

Parameters
Name	Description
metric_name	str The resource name of the metric to update: :: "projects/[PROJECT_ID]/metrics/[METRIC_ID]" The updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.
metric	Union[dict, LogMetric] The updated metric. If a dict is provided, it must be of the same form as the protobuf message LogMetric
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.