public static final class LogMetric.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder> implements LogMetricOrBuilder
Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval. Logs-based metric can also be used to extract values from logs and create a a distribution of the values. The distribution records the statistics of the extracted values along with an optional histogram of the values as specified by the bucket options.Protobuf type
google.logging.v2.LogMetric| Modifier and Type | Method and Description |
|---|---|
LogMetric.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) |
LogMetric |
build() |
LogMetric |
buildPartial() |
LogMetric.Builder |
clear() |
LogMetric.Builder |
clearBucketOptions()
Optional.
|
LogMetric.Builder |
clearDescription()
Optional.
|
LogMetric.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
LogMetric.Builder |
clearFilter()
Required.
|
LogMetric.Builder |
clearLabelExtractors() |
LogMetric.Builder |
clearMetricDescriptor()
Optional.
|
LogMetric.Builder |
clearName()
Required.
|
LogMetric.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
LogMetric.Builder |
clearValueExtractor()
Optional.
|
LogMetric.Builder |
clearVersion()
Deprecated.
|
LogMetric.Builder |
clone() |
boolean |
containsLabelExtractors(java.lang.String key)
Optional.
|
com.google.api.Distribution.BucketOptions |
getBucketOptions()
Optional.
|
com.google.api.Distribution.BucketOptions.Builder |
getBucketOptionsBuilder()
Optional.
|
com.google.api.Distribution.BucketOptionsOrBuilder |
getBucketOptionsOrBuilder()
Optional.
|
LogMetric |
getDefaultInstanceForType() |
java.lang.String |
getDescription()
Optional.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
Optional.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
java.lang.String |
getFilter()
Required.
|
com.google.protobuf.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.
|
com.google.api.MetricDescriptor |
getMetricDescriptor()
Optional.
|
com.google.api.MetricDescriptor.Builder |
getMetricDescriptorBuilder()
Optional.
|
com.google.api.MetricDescriptorOrBuilder |
getMetricDescriptorOrBuilder()
Optional.
|
java.util.Map<java.lang.String,java.lang.String> |
getMutableLabelExtractors()
Deprecated.
|
java.lang.String |
getName()
Required.
|
com.google.protobuf.ByteString |
getNameBytes()
Required.
|
java.lang.String |
getValueExtractor()
Optional.
|
com.google.protobuf.ByteString |
getValueExtractorBytes()
Optional.
|
LogMetric.ApiVersion |
getVersion()
Deprecated.
|
int |
getVersionValue()
Deprecated.
|
boolean |
hasBucketOptions()
Optional.
|
boolean |
hasMetricDescriptor()
Optional.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
protected com.google.protobuf.MapField |
internalGetMutableMapField(int number) |
boolean |
isInitialized() |
LogMetric.Builder |
mergeBucketOptions(com.google.api.Distribution.BucketOptions value)
Optional.
|
LogMetric.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
LogMetric.Builder |
mergeFrom(LogMetric other) |
LogMetric.Builder |
mergeFrom(com.google.protobuf.Message other) |
LogMetric.Builder |
mergeMetricDescriptor(com.google.api.MetricDescriptor value)
Optional.
|
LogMetric.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
LogMetric.Builder |
putAllLabelExtractors(java.util.Map<java.lang.String,java.lang.String> values)
Optional.
|
LogMetric.Builder |
putLabelExtractors(java.lang.String key,
java.lang.String value)
Optional.
|
LogMetric.Builder |
removeLabelExtractors(java.lang.String key)
Optional.
|
LogMetric.Builder |
setBucketOptions(com.google.api.Distribution.BucketOptions.Builder builderForValue)
Optional.
|
LogMetric.Builder |
setBucketOptions(com.google.api.Distribution.BucketOptions value)
Optional.
|
LogMetric.Builder |
setDescription(java.lang.String value)
Optional.
|
LogMetric.Builder |
setDescriptionBytes(com.google.protobuf.ByteString value)
Optional.
|
LogMetric.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) |
LogMetric.Builder |
setFilter(java.lang.String value)
Required.
|
LogMetric.Builder |
setFilterBytes(com.google.protobuf.ByteString value)
Required.
|
LogMetric.Builder |
setMetricDescriptor(com.google.api.MetricDescriptor.Builder builderForValue)
Optional.
|
LogMetric.Builder |
setMetricDescriptor(com.google.api.MetricDescriptor value)
Optional.
|
LogMetric.Builder |
setName(java.lang.String value)
Required.
|
LogMetric.Builder |
setNameBytes(com.google.protobuf.ByteString value)
Required.
|
LogMetric.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
java.lang.Object value) |
LogMetric.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
LogMetric.Builder |
setValueExtractor(java.lang.String value)
Optional.
|
LogMetric.Builder |
setValueExtractorBytes(com.google.protobuf.ByteString value)
Optional.
|
LogMetric.Builder |
setVersion(LogMetric.ApiVersion value)
Deprecated.
|
LogMetric.Builder |
setVersionValue(int value)
Deprecated.
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>protected com.google.protobuf.MapField internalGetMutableMapField(int number)
internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>public LogMetric.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>public LogMetric getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic LogMetric build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic LogMetric buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic LogMetric.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>public LogMetric.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>public LogMetric.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>public LogMetric.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>public LogMetric.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>public LogMetric.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>public LogMetric.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<LogMetric.Builder>public LogMetric.Builder mergeFrom(LogMetric other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>public LogMetric.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<LogMetric.Builder>java.io.IOExceptionpublic java.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;getName in interface LogMetricOrBuilderpublic com.google.protobuf.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;getNameBytes in interface LogMetricOrBuilderpublic LogMetric.Builder setName(java.lang.String value)
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;public LogMetric.Builder clearName()
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;public LogMetric.Builder setNameBytes(com.google.protobuf.ByteString value)
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;public java.lang.String getDescription()
Optional. A description of this metric, which is used in documentation.
string description = 2;getDescription in interface LogMetricOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
Optional. A description of this metric, which is used in documentation.
string description = 2;getDescriptionBytes in interface LogMetricOrBuilderpublic LogMetric.Builder setDescription(java.lang.String value)
Optional. A description of this metric, which is used in documentation.
string description = 2;public LogMetric.Builder clearDescription()
Optional. A description of this metric, which is used in documentation.
string description = 2;public LogMetric.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
Optional. A description of this metric, which is used in documentation.
string description = 2;public 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;getFilter in interface LogMetricOrBuilderpublic com.google.protobuf.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;getFilterBytes in interface LogMetricOrBuilderpublic LogMetric.Builder setFilter(java.lang.String value)
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;public LogMetric.Builder clearFilter()
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;public LogMetric.Builder setFilterBytes(com.google.protobuf.ByteString value)
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;public 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;hasMetricDescriptor in interface LogMetricOrBuilderpublic com.google.api.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;getMetricDescriptor in interface LogMetricOrBuilderpublic LogMetric.Builder setMetricDescriptor(com.google.api.MetricDescriptor value)
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;public LogMetric.Builder setMetricDescriptor(com.google.api.MetricDescriptor.Builder builderForValue)
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;public LogMetric.Builder mergeMetricDescriptor(com.google.api.MetricDescriptor value)
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;public LogMetric.Builder clearMetricDescriptor()
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;public com.google.api.MetricDescriptor.Builder getMetricDescriptorBuilder()
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;public com.google.api.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;getMetricDescriptorOrBuilder in interface LogMetricOrBuilderpublic 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;getValueExtractor in interface LogMetricOrBuilderpublic com.google.protobuf.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;getValueExtractorBytes in interface LogMetricOrBuilderpublic LogMetric.Builder setValueExtractor(java.lang.String value)
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;public LogMetric.Builder clearValueExtractor()
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;public LogMetric.Builder setValueExtractorBytes(com.google.protobuf.ByteString value)
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;public int getLabelExtractorsCount()
LogMetricOrBuilderOptional. 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;getLabelExtractorsCount in interface LogMetricOrBuilderpublic 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;containsLabelExtractors in interface LogMetricOrBuilder@Deprecated public java.util.Map<java.lang.String,java.lang.String> getLabelExtractors()
getLabelExtractorsMap() instead.getLabelExtractors in interface LogMetricOrBuilderpublic 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;getLabelExtractorsMap in interface LogMetricOrBuilderpublic 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;getLabelExtractorsOrDefault in interface LogMetricOrBuilderpublic 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;getLabelExtractorsOrThrow in interface LogMetricOrBuilderpublic LogMetric.Builder clearLabelExtractors()
public LogMetric.Builder removeLabelExtractors(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 public java.util.Map<java.lang.String,java.lang.String> getMutableLabelExtractors()
public LogMetric.Builder putLabelExtractors(java.lang.String key, java.lang.String value)
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;public LogMetric.Builder putAllLabelExtractors(java.util.Map<java.lang.String,java.lang.String> values)
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;public 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;hasBucketOptions in interface LogMetricOrBuilderpublic com.google.api.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;getBucketOptions in interface LogMetricOrBuilderpublic LogMetric.Builder setBucketOptions(com.google.api.Distribution.BucketOptions value)
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;public LogMetric.Builder setBucketOptions(com.google.api.Distribution.BucketOptions.Builder builderForValue)
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;public LogMetric.Builder mergeBucketOptions(com.google.api.Distribution.BucketOptions value)
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;public LogMetric.Builder clearBucketOptions()
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;public com.google.api.Distribution.BucketOptions.Builder getBucketOptionsBuilder()
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;public com.google.api.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;getBucketOptionsOrBuilder in interface LogMetricOrBuilderpublic 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;getVersionValue in interface LogMetricOrBuilderpublic LogMetric.Builder setVersionValue(int value)
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;public 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;getVersion in interface LogMetricOrBuilderpublic LogMetric.Builder setVersion(LogMetric.ApiVersion value)
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;public LogMetric.Builder clearVersion()
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;public final LogMetric.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>public final LogMetric.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<LogMetric.Builder>