public interface LogMetricOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLabelExtractors(String key)
public abstract boolean containsLabelExtractors(String key) Optional. A map from a label key string to an extractor expression which is
used to extract data from a log entry field and assign as the label value.
Each label key specified in the LabelDescriptor must have an associated
extractor expression in this map. The syntax of the extractor expression
is the same as for the value_extractor field.
The extracted value is converted to the type defined in the label
descriptor. If the either the extraction or the type conversion fails,
the label will have a default value. The default value for a string
label is an empty string, for an integer label its 0, and for a boolean
label its false.
Note that there are upper bounds on the maximum number of labels and the
number of active time series that are allowed in a project.
map<string, string> label_extractors = 7 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| key | String |
| Type | Description |
| boolean |
getBucketOptions()
public abstract Distribution.BucketOptions getBucketOptions() Optional. The bucket_options are required when the logs-based metric is
using a DISTRIBUTION value type and it describes the bucket boundaries
used to create a histogram of the extracted values.
.google.api.Distribution.BucketOptions bucket_options = 8 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| com.google.api.Distribution.BucketOptions | The bucketOptions. |
getBucketOptionsOrBuilder()
public abstract Distribution.BucketOptionsOrBuilder getBucketOptionsOrBuilder() Optional. The bucket_options are required when the logs-based metric is
using a DISTRIBUTION value type and it describes the bucket boundaries
used to create a histogram of the extracted values.
.google.api.Distribution.BucketOptions bucket_options = 8 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| com.google.api.Distribution.BucketOptionsOrBuilder |
getCreateTime()
public abstract Timestamp getCreateTime()Output only. The creation timestamp of the metric. This field may not be present for older metrics.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| Timestamp | The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Output only. The creation timestamp of the metric. This field may not be present for older metrics.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| TimestampOrBuilder |
getDescription()
public abstract String getDescription()Optional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()Optional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| ByteString | The bytes for description. |
getFilter()
public abstract String getFilter()Required. An advanced logs filter which is used to match log entries. Example: "resource.type=gae_app AND severity>=ERROR" The maximum length of the filter is 20000 characters.
string filter = 3 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The filter. |
getFilterBytes()
public abstract ByteString getFilterBytes()Required. An advanced logs filter which is used to match log entries. Example: "resource.type=gae_app AND severity>=ERROR" The maximum length of the filter is 20000 characters.
string filter = 3 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| ByteString | The bytes for filter. |
getLabelExtractors()
public abstract Map<String,String> getLabelExtractors()Use #getLabelExtractorsMap() instead.
| Type | Description |
| Map<String,String> |
getLabelExtractorsCount()
public abstract int getLabelExtractorsCount() Optional. A map from a label key string to an extractor expression which is
used to extract data from a log entry field and assign as the label value.
Each label key specified in the LabelDescriptor must have an associated
extractor expression in this map. The syntax of the extractor expression
is the same as for the value_extractor field.
The extracted value is converted to the type defined in the label
descriptor. If the either the extraction or the type conversion fails,
the label will have a default value. The default value for a string
label is an empty string, for an integer label its 0, and for a boolean
label its false.
Note that there are upper bounds on the maximum number of labels and the
number of active time series that are allowed in a project.
map<string, string> label_extractors = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| int |
getLabelExtractorsMap()
public abstract Map<String,String> getLabelExtractorsMap() Optional. A map from a label key string to an extractor expression which is
used to extract data from a log entry field and assign as the label value.
Each label key specified in the LabelDescriptor must have an associated
extractor expression in this map. The syntax of the extractor expression
is the same as for the value_extractor field.
The extracted value is converted to the type defined in the label
descriptor. If the either the extraction or the type conversion fails,
the label will have a default value. The default value for a string
label is an empty string, for an integer label its 0, and for a boolean
label its false.
Note that there are upper bounds on the maximum number of labels and the
number of active time series that are allowed in a project.
map<string, string> label_extractors = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| Map<String,String> |
getLabelExtractorsOrDefault(String key, String defaultValue)
public abstract String getLabelExtractorsOrDefault(String key, String defaultValue) Optional. A map from a label key string to an extractor expression which is
used to extract data from a log entry field and assign as the label value.
Each label key specified in the LabelDescriptor must have an associated
extractor expression in this map. The syntax of the extractor expression
is the same as for the value_extractor field.
The extracted value is converted to the type defined in the label
descriptor. If the either the extraction or the type conversion fails,
the label will have a default value. The default value for a string
label is an empty string, for an integer label its 0, and for a boolean
label its false.
Note that there are upper bounds on the maximum number of labels and the
number of active time series that are allowed in a project.
map<string, string> label_extractors = 7 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| key | String |
| defaultValue | String |
| Type | Description |
| String |
getLabelExtractorsOrThrow(String key)
public abstract String getLabelExtractorsOrThrow(String key) Optional. A map from a label key string to an extractor expression which is
used to extract data from a log entry field and assign as the label value.
Each label key specified in the LabelDescriptor must have an associated
extractor expression in this map. The syntax of the extractor expression
is the same as for the value_extractor field.
The extracted value is converted to the type defined in the label
descriptor. If the either the extraction or the type conversion fails,
the label will have a default value. The default value for a string
label is an empty string, for an integer label its 0, and for a boolean
label its false.
Note that there are upper bounds on the maximum number of labels and the
number of active time series that are allowed in a project.
map<string, string> label_extractors = 7 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| key | String |
| Type | Description |
| String |
getMetricDescriptor()
public abstract MetricDescriptor getMetricDescriptor() Optional. The metric descriptor associated with the logs-based metric.
If unspecified, it uses a default metric descriptor with a DELTA metric
kind, INT64 value type, with no labels and a unit of "1". Such a metric
counts the number of log entries matching the filter expression.
The name, type, and description fields in the metric_descriptor
are output only, and is constructed using the name and description
field in the LogMetric.
To create a logs-based metric that records a distribution of log values, a
DELTA metric kind with a DISTRIBUTION value type must be used along with
a value_extractor expression in the LogMetric.
Each label in the metric descriptor must have a matching label
name as the key and an extractor expression as the value in the
label_extractors map.
The metric_kind and value_type fields in the metric_descriptor cannot
be updated once initially configured. New labels can be added in the
metric_descriptor, but existing labels cannot be modified except for
their description.
.google.api.MetricDescriptor metric_descriptor = 5 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| com.google.api.MetricDescriptor | The metricDescriptor. |
getMetricDescriptorOrBuilder()
public abstract MetricDescriptorOrBuilder getMetricDescriptorOrBuilder() Optional. The metric descriptor associated with the logs-based metric.
If unspecified, it uses a default metric descriptor with a DELTA metric
kind, INT64 value type, with no labels and a unit of "1". Such a metric
counts the number of log entries matching the filter expression.
The name, type, and description fields in the metric_descriptor
are output only, and is constructed using the name and description
field in the LogMetric.
To create a logs-based metric that records a distribution of log values, a
DELTA metric kind with a DISTRIBUTION value type must be used along with
a value_extractor expression in the LogMetric.
Each label in the metric descriptor must have a matching label
name as the key and an extractor expression as the value in the
label_extractors map.
The metric_kind and value_type fields in the metric_descriptor cannot
be updated once initially configured. New labels can be added in the
metric_descriptor, but existing labels cannot be modified except for
their description.
.google.api.MetricDescriptor metric_descriptor = 5 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| com.google.api.MetricDescriptorOrBuilder |
getName()
public abstract String getName() Required. The client-assigned metric identifier.
Examples: "error_count", "nginx/requests".
Metric identifiers are limited to 100 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.
The metric identifier in this field must not be
URL-encoded.
However, when the metric identifier appears as the [METRIC_ID] part of a
metric_name API parameter, then the metric identifier must be
URL-encoded. Example: "projects/my-project/metrics/nginx%2Frequests".
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The name. |
getNameBytes()
public abstract ByteString getNameBytes() Required. The client-assigned metric identifier.
Examples: "error_count", "nginx/requests".
Metric identifiers are limited to 100 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.
The metric identifier in this field must not be
URL-encoded.
However, when the metric identifier appears as the [METRIC_ID] part of a
metric_name API parameter, then the metric identifier must be
URL-encoded. Example: "projects/my-project/metrics/nginx%2Frequests".
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| ByteString | The bytes for name. |
getUpdateTime()
public abstract Timestamp getUpdateTime()Output only. The last update timestamp of the metric. This field may not be present for older metrics.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| Timestamp | The updateTime. |
getUpdateTimeOrBuilder()
public abstract TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The last update timestamp of the metric. This field may not be present for older metrics.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| TimestampOrBuilder |
getValueExtractor()
public abstract String getValueExtractor() Optional. A value_extractor is required when using a distribution
logs-based metric to extract the values to record from a log entry.
Two functions are supported for value extraction: EXTRACT(field) or
REGEXP_EXTRACT(field, regex). The argument are:
- field: The name of the log entry field from which the value is to be extracted.
- regex: A regular expression using the Google RE2 syntax
(https://github.com/google/re2/wiki/Syntax) with a single capture
group to extract data from the specified log entry field. The value
of the field is converted to a string before applying the regex.
It is an error to specify a regex that does not include exactly one
capture group.
The result of the extraction must be convertible to a double type, as the
distribution always records double values. If either the extraction or
the conversion to double fails, then those values are not recorded in the
distribution.
Example:
REGEXP_EXTRACT(jsonPayload.request, ".quantity=(\d+).")
string value_extractor = 6 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The valueExtractor. |
getValueExtractorBytes()
public abstract ByteString getValueExtractorBytes() Optional. A value_extractor is required when using a distribution
logs-based metric to extract the values to record from a log entry.
Two functions are supported for value extraction: EXTRACT(field) or
REGEXP_EXTRACT(field, regex). The argument are:
- field: The name of the log entry field from which the value is to be extracted.
- regex: A regular expression using the Google RE2 syntax
(https://github.com/google/re2/wiki/Syntax) with a single capture
group to extract data from the specified log entry field. The value
of the field is converted to a string before applying the regex.
It is an error to specify a regex that does not include exactly one
capture group.
The result of the extraction must be convertible to a double type, as the
distribution always records double values. If either the extraction or
the conversion to double fails, then those values are not recorded in the
distribution.
Example:
REGEXP_EXTRACT(jsonPayload.request, ".quantity=(\d+).")
string value_extractor = 6 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| ByteString | The bytes for valueExtractor. |
getVersion()
public abstract LogMetric.ApiVersion getVersion()Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.
.google.logging.v2.LogMetric.ApiVersion version = 4 [deprecated = true];
| Type | Description |
| LogMetric.ApiVersion | The version. |
getVersionValue()
public abstract int getVersionValue()Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.
.google.logging.v2.LogMetric.ApiVersion version = 4 [deprecated = true];
| Type | Description |
| int | The enum numeric value on the wire for version. |
hasBucketOptions()
public abstract boolean hasBucketOptions() Optional. The bucket_options are required when the logs-based metric is
using a DISTRIBUTION value type and it describes the bucket boundaries
used to create a histogram of the extracted values.
.google.api.Distribution.BucketOptions bucket_options = 8 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the bucketOptions field is set. |
hasCreateTime()
public abstract boolean hasCreateTime()Output only. The creation timestamp of the metric. This field may not be present for older metrics.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set. |
hasMetricDescriptor()
public abstract boolean hasMetricDescriptor() Optional. The metric descriptor associated with the logs-based metric.
If unspecified, it uses a default metric descriptor with a DELTA metric
kind, INT64 value type, with no labels and a unit of "1". Such a metric
counts the number of log entries matching the filter expression.
The name, type, and description fields in the metric_descriptor
are output only, and is constructed using the name and description
field in the LogMetric.
To create a logs-based metric that records a distribution of log values, a
DELTA metric kind with a DISTRIBUTION value type must be used along with
a value_extractor expression in the LogMetric.
Each label in the metric descriptor must have a matching label
name as the key and an extractor expression as the value in the
label_extractors map.
The metric_kind and value_type fields in the metric_descriptor cannot
be updated once initially configured. New labels can be added in the
metric_descriptor, but existing labels cannot be modified except for
their description.
.google.api.MetricDescriptor metric_descriptor = 5 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the metricDescriptor field is set. |
hasUpdateTime()
public abstract boolean hasUpdateTime()Output only. The last update timestamp of the metric. This field may not be present for older metrics.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the updateTime field is set. |