public interface LogMetricOrBuilder extends MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabelExtractors(java.lang.String key)
Optional.
|
Distribution.BucketOptions |
getBucketOptions()
Optional.
|
Distribution.BucketOptionsOrBuilder |
getBucketOptionsOrBuilder()
Optional.
|
java.lang.String |
getDescription()
Optional.
|
ByteString |
getDescriptionBytes()
Optional.
|
java.lang.String |
getFilter()
Required.
|
ByteString |
getFilterBytes()
Required.
|
java.util.Map<java.lang.String,java.lang.String> |
getLabelExtractors()
Deprecated.
|
int |
getLabelExtractorsCount()
Optional.
|
java.util.Map<java.lang.String,java.lang.String> |
getLabelExtractorsMap()
Optional.
|
java.lang.String |
getLabelExtractorsOrDefault(java.lang.String key,
java.lang.String defaultValue)
Optional.
|
java.lang.String |
getLabelExtractorsOrThrow(java.lang.String key)
Optional.
|
MetricDescriptor |
getMetricDescriptor()
Optional.
|
MetricDescriptorOrBuilder |
getMetricDescriptorOrBuilder()
Optional.
|
java.lang.String |
getName()
Required.
|
ByteString |
getNameBytes()
Required.
|
java.lang.String |
getValueExtractor()
Optional.
|
ByteString |
getValueExtractorBytes()
Optional.
|
LogMetric.ApiVersion |
getVersion()
Deprecated.
|
int |
getVersionValue()
Deprecated.
|
boolean |
hasBucketOptions()
Optional.
|
boolean |
hasMetricDescriptor()
Optional.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofisInitializedjava.lang.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](https://en.wikipedia.org/wiki/Percent-encoding). 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;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](https://en.wikipedia.org/wiki/Percent-encoding). 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;java.lang.String getDescription()
Optional. A description of this metric, which is used in documentation.
string description = 2;ByteString getDescriptionBytes()
Optional. A description of this metric, which is used in documentation.
string description = 2;java.lang.String getFilter()
Required. An [advanced logs filter](/logging/docs/view/advanced_filters)
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;ByteString getFilterBytes()
Required. An [advanced logs filter](/logging/docs/view/advanced_filters)
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;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;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;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;java.lang.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:
1. field: The name of the log entry field from which the value is to be
extracted.
2. 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;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:
1. field: The name of the log entry field from which the value is to be
extracted.
2. 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;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;boolean containsLabelExtractors(java.lang.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;@Deprecated java.util.Map<java.lang.String,java.lang.String> getLabelExtractors()
getLabelExtractorsMap() instead.java.util.Map<java.lang.String,java.lang.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;java.lang.String getLabelExtractorsOrDefault(java.lang.String key,
java.lang.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;java.lang.String getLabelExtractorsOrThrow(java.lang.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;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;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;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;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;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;