Package com.google.logging.v2
Class LogMetric
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.logging.v2.LogMetric
-
- All Implemented Interfaces:
LogMetricOrBuilder
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Serializable
public final class LogMetric extends com.google.protobuf.GeneratedMessageV3 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 metrics can also be used to extract values from logs and create 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 typegoogle.logging.v2.LogMetric
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
LogMetric.ApiVersion
Logging API version.static class
LogMetric.Builder
Describes a logs-based metric.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static int
BUCKET_NAME_FIELD_NUMBER
static int
BUCKET_OPTIONS_FIELD_NUMBER
static int
CREATE_TIME_FIELD_NUMBER
static int
DESCRIPTION_FIELD_NUMBER
static int
DISABLED_FIELD_NUMBER
static int
FILTER_FIELD_NUMBER
static int
LABEL_EXTRACTORS_FIELD_NUMBER
static int
METRIC_DESCRIPTOR_FIELD_NUMBER
static int
NAME_FIELD_NUMBER
static int
UPDATE_TIME_FIELD_NUMBER
static int
VALUE_EXTRACTOR_FIELD_NUMBER
static int
VERSION_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
containsLabelExtractors(String key)
Optional.boolean
equals(Object obj)
String
getBucketName()
Optional.com.google.protobuf.ByteString
getBucketNameBytes()
Optional.com.google.api.Distribution.BucketOptions
getBucketOptions()
Optional.com.google.api.Distribution.BucketOptionsOrBuilder
getBucketOptionsOrBuilder()
Optional.com.google.protobuf.Timestamp
getCreateTime()
Output only.com.google.protobuf.TimestampOrBuilder
getCreateTimeOrBuilder()
Output only.static LogMetric
getDefaultInstance()
LogMetric
getDefaultInstanceForType()
String
getDescription()
Optional.com.google.protobuf.ByteString
getDescriptionBytes()
Optional.static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
boolean
getDisabled()
Optional.String
getFilter()
Required.com.google.protobuf.ByteString
getFilterBytes()
Required.Map<String,String>
getLabelExtractors()
Deprecated.int
getLabelExtractorsCount()
Optional.Map<String,String>
getLabelExtractorsMap()
Optional.String
getLabelExtractorsOrDefault(String key, String defaultValue)
Optional.String
getLabelExtractorsOrThrow(String key)
Optional.com.google.api.MetricDescriptor
getMetricDescriptor()
Optional.com.google.api.MetricDescriptorOrBuilder
getMetricDescriptorOrBuilder()
Optional.String
getName()
Required.com.google.protobuf.ByteString
getNameBytes()
Required.com.google.protobuf.Parser<LogMetric>
getParserForType()
int
getSerializedSize()
com.google.protobuf.Timestamp
getUpdateTime()
Output only.com.google.protobuf.TimestampOrBuilder
getUpdateTimeOrBuilder()
Output only.String
getValueExtractor()
Optional.com.google.protobuf.ByteString
getValueExtractorBytes()
Optional.LogMetric.ApiVersion
getVersion()
Deprecated.google.logging.v2.LogMetric.version is deprecated.int
getVersionValue()
Deprecated.google.logging.v2.LogMetric.version is deprecated.boolean
hasBucketOptions()
Optional.boolean
hasCreateTime()
Output only.int
hashCode()
boolean
hasMetricDescriptor()
Optional.boolean
hasUpdateTime()
Output only.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
protected com.google.protobuf.MapField
internalGetMapField(int number)
boolean
isInitialized()
static LogMetric.Builder
newBuilder()
static LogMetric.Builder
newBuilder(LogMetric prototype)
LogMetric.Builder
newBuilderForType()
protected LogMetric.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static LogMetric
parseDelimitedFrom(InputStream input)
static LogMetric
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LogMetric
parseFrom(byte[] data)
static LogMetric
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LogMetric
parseFrom(com.google.protobuf.ByteString data)
static LogMetric
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LogMetric
parseFrom(com.google.protobuf.CodedInputStream input)
static LogMetric
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LogMetric
parseFrom(InputStream input)
static LogMetric
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LogMetric
parseFrom(ByteBuffer data)
static LogMetric
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<LogMetric>
parser()
LogMetric.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
- See Also:
- Constant Field Values
-
BUCKET_NAME_FIELD_NUMBER
public static final int BUCKET_NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DISABLED_FIELD_NUMBER
public static final int DISABLED_FIELD_NUMBER
- See Also:
- Constant Field Values
-
METRIC_DESCRIPTOR_FIELD_NUMBER
public static final int METRIC_DESCRIPTOR_FIELD_NUMBER
- See Also:
- Constant Field Values
-
VALUE_EXTRACTOR_FIELD_NUMBER
public static final int VALUE_EXTRACTOR_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LABEL_EXTRACTORS_FIELD_NUMBER
public static final int LABEL_EXTRACTORS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
BUCKET_OPTIONS_FIELD_NUMBER
public static final int BUCKET_OPTIONS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
VERSION_FIELD_NUMBER
public static final int VERSION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapField
in classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getName
public 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. This field is the `[METRIC_ID]` part of a metric resource name in the format "projects/[PROJECT_ID]/metrics/[METRIC_ID]". Example: If the resource name of a metric is `"projects/my-project/metrics/nginx%2Frequests"`, this field's value is `"nginx/requests"`.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getName
in interfaceLogMetricOrBuilder
- Returns:
- The name.
-
getNameBytes
public 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. This field is the `[METRIC_ID]` part of a metric resource name in the format "projects/[PROJECT_ID]/metrics/[METRIC_ID]". Example: If the resource name of a metric is `"projects/my-project/metrics/nginx%2Frequests"`, this field's value is `"nginx/requests"`.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getNameBytes
in interfaceLogMetricOrBuilder
- Returns:
- The bytes for name.
-
getDescription
public 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];
- Specified by:
getDescription
in interfaceLogMetricOrBuilder
- Returns:
- The description.
-
getDescriptionBytes
public com.google.protobuf.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];
- Specified by:
getDescriptionBytes
in interfaceLogMetricOrBuilder
- Returns:
- The bytes for description.
-
getFilter
public String getFilter()
Required. An [advanced logs filter](https://cloud.google.com/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 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getFilter
in interfaceLogMetricOrBuilder
- Returns:
- The filter.
-
getFilterBytes
public com.google.protobuf.ByteString getFilterBytes()
Required. An [advanced logs filter](https://cloud.google.com/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 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getFilterBytes
in interfaceLogMetricOrBuilder
- Returns:
- The bytes for filter.
-
getBucketName
public String getBucketName()
Optional. The resource name of the Log Bucket that owns the Log Metric. Only Log Buckets in projects are supported. The bucket has to be in the same project as the metric. For example: `projects/my-project/locations/global/buckets/my-bucket` If empty, then the Log Metric is considered a non-Bucket Log Metric.
string bucket_name = 13 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getBucketName
in interfaceLogMetricOrBuilder
- Returns:
- The bucketName.
-
getBucketNameBytes
public com.google.protobuf.ByteString getBucketNameBytes()
Optional. The resource name of the Log Bucket that owns the Log Metric. Only Log Buckets in projects are supported. The bucket has to be in the same project as the metric. For example: `projects/my-project/locations/global/buckets/my-bucket` If empty, then the Log Metric is considered a non-Bucket Log Metric.
string bucket_name = 13 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getBucketNameBytes
in interfaceLogMetricOrBuilder
- Returns:
- The bytes for bucketName.
-
getDisabled
public boolean getDisabled()
Optional. If set to True, then this metric is disabled and it does not generate any points.
bool disabled = 12 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getDisabled
in interfaceLogMetricOrBuilder
- Returns:
- The disabled.
-
hasMetricDescriptor
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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
hasMetricDescriptor
in interfaceLogMetricOrBuilder
- Returns:
- Whether the metricDescriptor field is set.
-
getMetricDescriptor
public 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getMetricDescriptor
in interfaceLogMetricOrBuilder
- Returns:
- The metricDescriptor.
-
getMetricDescriptorOrBuilder
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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getMetricDescriptorOrBuilder
in interfaceLogMetricOrBuilder
-
getValueExtractor
public 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 arguments 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getValueExtractor
in interfaceLogMetricOrBuilder
- Returns:
- The valueExtractor.
-
getValueExtractorBytes
public 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 arguments 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getValueExtractorBytes
in interfaceLogMetricOrBuilder
- Returns:
- The bytes for valueExtractor.
-
getLabelExtractorsCount
public int getLabelExtractorsCount()
Description copied from interface:LogMetricOrBuilder
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 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];
- Specified by:
getLabelExtractorsCount
in interfaceLogMetricOrBuilder
-
containsLabelExtractors
public 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 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];
- Specified by:
containsLabelExtractors
in interfaceLogMetricOrBuilder
-
getLabelExtractors
@Deprecated public Map<String,String> getLabelExtractors()
Deprecated.UsegetLabelExtractorsMap()
instead.- Specified by:
getLabelExtractors
in interfaceLogMetricOrBuilder
-
getLabelExtractorsMap
public 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 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];
- Specified by:
getLabelExtractorsMap
in interfaceLogMetricOrBuilder
-
getLabelExtractorsOrDefault
public 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 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];
- Specified by:
getLabelExtractorsOrDefault
in interfaceLogMetricOrBuilder
-
getLabelExtractorsOrThrow
public 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 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];
- Specified by:
getLabelExtractorsOrThrow
in interfaceLogMetricOrBuilder
-
hasBucketOptions
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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
hasBucketOptions
in interfaceLogMetricOrBuilder
- Returns:
- Whether the bucketOptions field is set.
-
getBucketOptions
public 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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getBucketOptions
in interfaceLogMetricOrBuilder
- Returns:
- The bucketOptions.
-
getBucketOptionsOrBuilder
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 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getBucketOptionsOrBuilder
in interfaceLogMetricOrBuilder
-
hasCreateTime
public 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];
- Specified by:
hasCreateTime
in interfaceLogMetricOrBuilder
- Returns:
- Whether the createTime field is set.
-
getCreateTime
public com.google.protobuf.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];
- Specified by:
getCreateTime
in interfaceLogMetricOrBuilder
- Returns:
- The createTime.
-
getCreateTimeOrBuilder
public com.google.protobuf.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];
- Specified by:
getCreateTimeOrBuilder
in interfaceLogMetricOrBuilder
-
hasUpdateTime
public 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];
- Specified by:
hasUpdateTime
in interfaceLogMetricOrBuilder
- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
public com.google.protobuf.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];
- Specified by:
getUpdateTime
in interfaceLogMetricOrBuilder
- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
public com.google.protobuf.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];
- Specified by:
getUpdateTimeOrBuilder
in interfaceLogMetricOrBuilder
-
getVersionValue
@Deprecated public int getVersionValue()
Deprecated.google.logging.v2.LogMetric.version is deprecated. See google/logging/v2/logging_metrics.proto;l=237Deprecated. 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];
- Specified by:
getVersionValue
in interfaceLogMetricOrBuilder
- Returns:
- The enum numeric value on the wire for version.
-
getVersion
@Deprecated public LogMetric.ApiVersion getVersion()
Deprecated.google.logging.v2.LogMetric.version is deprecated. See google/logging/v2/logging_metrics.proto;l=237Deprecated. 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];
- Specified by:
getVersion
in interfaceLogMetricOrBuilder
- Returns:
- The version.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static LogMetric parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static LogMetric parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static LogMetric parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static LogMetric parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static LogMetric parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static LogMetric parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static LogMetric parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static LogMetric parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static LogMetric parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static LogMetric parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static LogMetric parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static LogMetric parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public LogMetric.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static LogMetric.Builder newBuilder()
-
newBuilder
public static LogMetric.Builder newBuilder(LogMetric prototype)
-
toBuilder
public LogMetric.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected LogMetric.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static LogMetric getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<LogMetric> parser()
-
getParserForType
public com.google.protobuf.Parser<LogMetric> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public LogMetric getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-