google.logging.v2.logging_metrics_pb2¶

Classes

class google.logging.v2.logging_metrics_pb2.CreateLogMetricRequest[source]¶

The parameters to CreateLogMetric.

parent¶

string – The resource name of the project in which to create the metric. Example: "projects/my-project-id".

The new metric must be provided in the request.

metric¶

google.logging.v2.logging_metrics_pb2.LogMetric – The new logs-based metric, which must not have an identifier that already exists.

class google.logging.v2.logging_metrics_pb2.DeleteLogMetricRequest[source]¶

The parameters to DeleteLogMetric.

metric_name¶

string – The resource name of the metric to delete. Example: "projects/my-project-id/metrics/my-metric-id".

class google.logging.v2.logging_metrics_pb2.GetLogMetricRequest[source]¶

The parameters to GetLogMetric.

metric_name¶

string – The resource name of the desired metric. Example: "projects/my-project-id/metrics/my-metric-id".

class google.logging.v2.logging_metrics_pb2.ListLogMetricsRequest[source]¶

The parameters to ListLogMetrics.

parent¶

string – Required. The resource name containing the metrics. Example: "projects/my-project-id".

page_token¶

string – Optional. If the pageToken parameter is supplied, then the next page of results is retrieved. The pageToken parameter must be set to the value of the nextPageToken from the previous response. The value of parent must be the same as in the previous request.

page_size¶

int – Optional. The maximum number of results to return from this request. You must check for presence of nextPageToken to determine if additional results are available, which you can retrieve by passing the nextPageToken value as the pageToken parameter in the next request.

class google.logging.v2.logging_metrics_pb2.ListLogMetricsResponse[source]¶

Result returned from ListLogMetrics.

metrics¶

list[google.logging.v2.logging_metrics_pb2.LogMetric] – A list of logs-based metrics.

next_page_token¶

string – If there are more results than were returned, then nextPageToken is included in the response. To get the next set of results, call this method again using the value of nextPageToken as pageToken.

class google.logging.v2.logging_metrics_pb2.LogMetric[source]¶

Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.

name¶

string – Required. The client-assigned metric identifier. Example: "severe_errors". Metric identifiers are limited to 1000 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/\. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.

description¶

string – A description of this metric, which is used in documentation.

filter¶

string – An advanced logs filter. Example: "logName:syslog AND severity>=ERROR".

class google.logging.v2.logging_metrics_pb2.UpdateLogMetricRequest[source]¶

The parameters to UpdateLogMetric.

metric_name¶

string – The resource name of the metric to update. Example: "projects/my-project-id/metrics/my-metric-id".

The updated metric must be provided in the request and have the same identifier that is specified in metricName. If the metric does not exist, it is created.

metric¶

google.logging.v2.logging_metrics_pb2.LogMetric – The updated metric, whose name must be the same as the metric identifier in metricName. If metricName does not exist, then a new metric is created.