Class LogMetric.Builder (3.16.2)

Version 3.16.2

• 3.20.6 (latest)
• 3.20.4
• 3.19.0
• 3.18.0
• 3.17.2
• 3.16.2
• 3.15.17
• 3.14.9
• 3.13.7
• 3.12.1
• 3.11.10
• 3.10.7
• 3.9.0
• 3.8.0
• 3.7.6
• 3.6.4
• 3.5.3

public static final class LogMetric.Builder extends 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 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 type google.logging.v2.LogMetric

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > LogMetric.Builder

Implements

LogMetricOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public LogMetric.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
LogMetric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public LogMetric build()

Returns
Type	Description
LogMetric

buildPartial()

public LogMetric buildPartial()

Returns
Type	Description
LogMetric

clear()

public LogMetric.Builder clear()

Returns
Type	Description
LogMetric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBucketName()

public LogMetric.Builder clearBucketName()

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];

Returns
Type	Description
LogMetric.Builder	This builder for chaining.

clearBucketOptions()

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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
LogMetric.Builder

clearCreateTime()

public LogMetric.Builder clearCreateTime()

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];

Returns
Type	Description
LogMetric.Builder

clearDescription()

public LogMetric.Builder clearDescription()

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];

Returns
Type	Description
LogMetric.Builder	This builder for chaining.

clearDisabled()

public LogMetric.Builder clearDisabled()

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];

Returns
Type	Description
LogMetric.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public LogMetric.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
LogMetric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilter()

public LogMetric.Builder clearFilter()

Required. An advanced logs filter which is used to match log entries. Example:

 "resource.type=gae_app AND severity>=ERROR"

The maximum length of the filter is 20000 characters.

string filter = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
LogMetric.Builder	This builder for chaining.

clearLabelExtractors()

public LogMetric.Builder clearLabelExtractors()

Returns
Type	Description
LogMetric.Builder

clearMetricDescriptor()

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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
LogMetric.Builder

clearName()

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.

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];

Returns
Type	Description
LogMetric.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public LogMetric.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
LogMetric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearUpdateTime()

public LogMetric.Builder clearUpdateTime()

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];

Returns
Type	Description
LogMetric.Builder

clearValueExtractor()

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 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];

Returns
Type	Description
LogMetric.Builder	This builder for chaining.

clearVersion() (deprecated)

public LogMetric.Builder clearVersion()

Deprecated. google.logging.v2.LogMetric.version is deprecated. See google/logging/v2/logging_metrics.proto;l=237

Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.

.google.logging.v2.LogMetric.ApiVersion version = 4 [deprecated = true];

Returns
Type	Description
LogMetric.Builder	This builder for chaining.

clone()

public LogMetric.Builder clone()

Returns
Type	Description
LogMetric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsLabelExtractors(String key)

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];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

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];

Returns
Type	Description
String	The bucketName.

getBucketNameBytes()

public 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];

Returns
Type	Description
ByteString	The bytes for bucketName.

getBucketOptions()

public 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];

Returns
Type	Description
com.google.api.Distribution.BucketOptions	The bucketOptions.

getBucketOptionsBuilder()

public 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
com.google.api.Distribution.BucketOptions.Builder

getBucketOptionsOrBuilder()

public 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];

Returns
Type	Description
com.google.api.Distribution.BucketOptionsOrBuilder

getCreateTime()

public 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];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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];

Returns
Type	Description
Builder

getCreateTimeOrBuilder()

public 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];

Returns
Type	Description
TimestampOrBuilder

getDefaultInstanceForType()

public LogMetric getDefaultInstanceForType()

Returns
Type	Description
LogMetric

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];

Returns
Type	Description
String	The description.

getDescriptionBytes()

public 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];

Returns
Type	Description
ByteString	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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];

Returns
Type	Description
boolean	The disabled.

getFilter()

public String getFilter()

Required. An advanced logs filter which is used to match log entries. Example:

 "resource.type=gae_app AND severity>=ERROR"

The maximum length of the filter is 20000 characters.

string filter = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The filter.

getFilterBytes()

public ByteString getFilterBytes()

Required. An advanced logs filter which is used to match log entries. Example:

 "resource.type=gae_app AND severity>=ERROR"

The maximum length of the filter is 20000 characters.

string filter = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for filter.

getLabelExtractors()

public Map<String,String> getLabelExtractors()

Use #getLabelExtractorsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelExtractorsCount()

public 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 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];

Returns
Type	Description
int

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];

Returns
Type	Description
Map<String,String>

getLabelExtractorsOrDefault(String key, String defaultValue)

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];

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelExtractorsOrThrow(String key)

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];

Parameter
Name	Description
key	String

Returns
Type	Description
String

getMetricDescriptor()

public 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];

Returns
Type	Description
com.google.api.MetricDescriptor	The metricDescriptor.

getMetricDescriptorBuilder()

public 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
com.google.api.MetricDescriptor.Builder

getMetricDescriptorOrBuilder()

public 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];

Returns
Type	Description
com.google.api.MetricDescriptorOrBuilder

getMutableLabelExtractors()

public Map<String,String> getMutableLabelExtractors()

Use alternate mutation accessors instead.

Returns
Type	Description
Map<String,String>

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];

Returns
Type	Description
String	The name.

getNameBytes()

public 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];

Returns
Type	Description
ByteString	The bytes for name.

getUpdateTime()

public 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];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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];

Returns
Type	Description
Builder

getUpdateTimeOrBuilder()

public 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];

Returns
Type	Description
TimestampOrBuilder

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];

Returns
Type	Description
String	The valueExtractor.

getValueExtractorBytes()

public 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];

Returns
Type	Description
ByteString	The bytes for valueExtractor.

getVersion() (deprecated)

public LogMetric.ApiVersion getVersion()

Deprecated. google.logging.v2.LogMetric.version is deprecated. See google/logging/v2/logging_metrics.proto;l=237

Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.

.google.logging.v2.LogMetric.ApiVersion version = 4 [deprecated = true];

Returns
Type	Description
LogMetric.ApiVersion	The version.

getVersionValue() (deprecated)

public int getVersionValue()

Deprecated. google.logging.v2.LogMetric.version is deprecated. See google/logging/v2/logging_metrics.proto;l=237

Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.

.google.logging.v2.LogMetric.ApiVersion version = 4 [deprecated = true];

Returns
Type	Description
int	The enum numeric value on the wire for version.

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];

Returns
Type	Description
boolean	Whether the bucketOptions field is set.

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];

Returns
Type	Description
boolean	Whether the createTime field is set.

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];

Returns
Type	Description
boolean	Whether the metricDescriptor field is set.

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];

Returns
Type	Description
boolean	Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeBucketOptions(Distribution.BucketOptions value)

public LogMetric.Builder mergeBucketOptions(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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	com.google.api.Distribution.BucketOptions

Returns
Type	Description
LogMetric.Builder

mergeCreateTime(Timestamp value)

public LogMetric.Builder mergeCreateTime(Timestamp value)

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];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
LogMetric.Builder

mergeFrom(LogMetric other)

public LogMetric.Builder mergeFrom(LogMetric other)

Parameter
Name	Description
other	LogMetric

Returns
Type	Description
LogMetric.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public LogMetric.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LogMetric.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public LogMetric.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
LogMetric.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeMetricDescriptor(MetricDescriptor value)

public LogMetric.Builder mergeMetricDescriptor(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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	com.google.api.MetricDescriptor

Returns
Type	Description
LogMetric.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final LogMetric.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
LogMetric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUpdateTime(Timestamp value)

public LogMetric.Builder mergeUpdateTime(Timestamp value)

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];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
LogMetric.Builder

putAllLabelExtractors(Map<String,String> values)

public LogMetric.Builder putAllLabelExtractors(Map<String,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 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];

Parameter
Name	Description
values	Map<String,String>

Returns
Type	Description
LogMetric.Builder

putLabelExtractors(String key, String value)

public LogMetric.Builder putLabelExtractors(String key, 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 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];

Parameters
Name	Description
key	String
value	String

Returns
Type	Description
LogMetric.Builder

removeLabelExtractors(String key)

public LogMetric.Builder removeLabelExtractors(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];

Parameter
Name	Description
key	String

Returns
Type	Description
LogMetric.Builder

setBucketName(String value)

public LogMetric.Builder setBucketName(String value)

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];

Parameter
Name	Description
value	String The bucketName to set.

Returns
Type	Description
LogMetric.Builder	This builder for chaining.

setBucketNameBytes(ByteString value)

public LogMetric.Builder setBucketNameBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for bucketName to set.

Returns
Type	Description
LogMetric.Builder	This builder for chaining.

setBucketOptions(Distribution.BucketOptions value)

public LogMetric.Builder setBucketOptions(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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	com.google.api.Distribution.BucketOptions

Returns
Type	Description
LogMetric.Builder

setBucketOptions(Distribution.BucketOptions.Builder builderForValue)

public LogMetric.Builder setBucketOptions(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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	com.google.api.Distribution.BucketOptions.Builder

Returns
Type	Description
LogMetric.Builder

setCreateTime(Timestamp value)

public LogMetric.Builder setCreateTime(Timestamp value)

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];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
LogMetric.Builder

setCreateTime(Timestamp.Builder builderForValue)

public LogMetric.Builder setCreateTime(Timestamp.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
LogMetric.Builder

setDescription(String value)

public LogMetric.Builder setDescription(String value)

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];

Parameter
Name	Description
value	String The description to set.

Returns
Type	Description
LogMetric.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public LogMetric.Builder setDescriptionBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for description to set.

Returns
Type	Description
LogMetric.Builder	This builder for chaining.

setDisabled(boolean value)

public LogMetric.Builder setDisabled(boolean value)

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];

Parameter
Name	Description
value	boolean The disabled to set.

Returns
Type	Description
LogMetric.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public LogMetric.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
LogMetric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilter(String value)

public LogMetric.Builder setFilter(String value)

Required. An advanced logs filter which is used to match log entries. Example:

 "resource.type=gae_app AND severity>=ERROR"

The maximum length of the filter is 20000 characters.

string filter = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The filter to set.

Returns
Type	Description
LogMetric.Builder	This builder for chaining.

setFilterBytes(ByteString value)

public LogMetric.Builder setFilterBytes(ByteString value)

Required. An advanced logs filter which is used to match log entries. Example:

 "resource.type=gae_app AND severity>=ERROR"

The maximum length of the filter is 20000 characters.

string filter = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes for filter to set.

Returns
Type	Description
LogMetric.Builder	This builder for chaining.

setMetricDescriptor(MetricDescriptor value)

public LogMetric.Builder setMetricDescriptor(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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	com.google.api.MetricDescriptor

Returns
Type	Description
LogMetric.Builder

setMetricDescriptor(MetricDescriptor.Builder builderForValue)

public LogMetric.Builder setMetricDescriptor(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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	com.google.api.MetricDescriptor.Builder

Returns
Type	Description
LogMetric.Builder

setName(String value)

public LogMetric.Builder setName(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.

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];

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
LogMetric.Builder	This builder for chaining.

setNameBytes(ByteString value)

public LogMetric.Builder setNameBytes(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.

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];

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
LogMetric.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public LogMetric.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
LogMetric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final LogMetric.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
LogMetric.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateTime(Timestamp value)

public LogMetric.Builder setUpdateTime(Timestamp value)

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];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
LogMetric.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public LogMetric.Builder setUpdateTime(Timestamp.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
LogMetric.Builder

setValueExtractor(String value)

public LogMetric.Builder setValueExtractor(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 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];

Parameter
Name	Description
value	String The valueExtractor to set.

Returns
Type	Description
LogMetric.Builder	This builder for chaining.

setValueExtractorBytes(ByteString value)

public LogMetric.Builder setValueExtractorBytes(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 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];

Parameter
Name	Description
value	ByteString The bytes for valueExtractor to set.

Returns
Type	Description
LogMetric.Builder	This builder for chaining.

setVersion(LogMetric.ApiVersion value) (deprecated)

public LogMetric.Builder setVersion(LogMetric.ApiVersion value)

Deprecated. google.logging.v2.LogMetric.version is deprecated. See google/logging/v2/logging_metrics.proto;l=237

Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.

.google.logging.v2.LogMetric.ApiVersion version = 4 [deprecated = true];

Parameter
Name	Description
value	LogMetric.ApiVersion The version to set.

Returns
Type	Description
LogMetric.Builder	This builder for chaining.

setVersionValue(int value) (deprecated)

public LogMetric.Builder setVersionValue(int value)

Deprecated. google.logging.v2.LogMetric.version is deprecated. See google/logging/v2/logging_metrics.proto;l=237

Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.

.google.logging.v2.LogMetric.ApiVersion version = 4 [deprecated = true];

Parameter
Name	Description
value	int The enum numeric value on the wire for version to set.

Returns
Type	Description
LogMetric.Builder	This builder for chaining.