# Class LogMetric.Builder (3.34.0)

3.34.0 (latest) 3.32.0 3.29.0 3.28.0 3.26.0 3.24.0 3.23.10 3.22.6 3.21.4 3.20.7 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 GeneratedMessage.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

[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \> [AbstractMessageLite.Builder\<MessageType,BuilderType\>](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessageLite.Builder.html) \> [AbstractMessage.Builder\<BuilderType\>](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.Builder.html) \> [GeneratedMessage.Builder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html) \> LogMetric.Builder

## Implements

[LogMetricOrBuilder](https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.LogMetricOrBuilder)

## Inherited Members

[AbstractMessage.Builder.findInitializationErrors()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.Builder.html#com_google_protobuf_AbstractMessage_Builder_findInitializationErrors__) [AbstractMessage.Builder.getInitializationErrorString()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.Builder.html#com_google_protobuf_AbstractMessage_Builder_getInitializationErrorString__) [AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.Builder.html#com_google_protobuf_AbstractMessage_Builder_internalMergeFrom_com_google_protobuf_AbstractMessageLite_) [AbstractMessage.Builder.mergeFrom(byte\[\])](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.Builder.html#com_google_protobuf_AbstractMessage_Builder_mergeFrom_byte___) [AbstractMessage.Builder.mergeFrom(byte\[\],ExtensionRegistryLite)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.Builder.html#com_google_protobuf_AbstractMessage_Builder_mergeFrom_byte___com_google_protobuf_ExtensionRegistryLite_) [AbstractMessage.Builder.mergeFrom(byte\[\],int,int)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.Builder.html#com_google_protobuf_AbstractMessage_Builder_mergeFrom_byte___int_int_) [AbstractMessage.Builder.mergeFrom(byte\[\],int,int,ExtensionRegistryLite)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.Builder.html#com_google_protobuf_AbstractMessage_Builder_mergeFrom_byte___int_int_com_google_protobuf_ExtensionRegistryLite_) [AbstractMessage.Builder.mergeFrom(ByteString)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.Builder.html#com_google_protobuf_AbstractMessage_Builder_mergeFrom_com_google_protobuf_ByteString_) [AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.Builder.html#com_google_protobuf_AbstractMessage_Builder_mergeFrom_com_google_protobuf_ByteString_com_google_protobuf_ExtensionRegistryLite_) [AbstractMessage.Builder.mergeFrom(CodedInputStream)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.Builder.html#com_google_protobuf_AbstractMessage_Builder_mergeFrom_com_google_protobuf_CodedInputStream_) [AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.Builder.html#com_google_protobuf_AbstractMessage_Builder_mergeFrom_com_google_protobuf_CodedInputStream_com_google_protobuf_ExtensionRegistryLite_) [AbstractMessage.Builder.mergeFrom(Message)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.Builder.html#com_google_protobuf_AbstractMessage_Builder_mergeFrom_com_google_protobuf_Message_) [AbstractMessage.Builder.mergeFrom(InputStream)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.Builder.html#com_google_protobuf_AbstractMessage_Builder_mergeFrom_java_io_InputStream_) [AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.Builder.html#com_google_protobuf_AbstractMessage_Builder_mergeFrom_java_io_InputStream_com_google_protobuf_ExtensionRegistryLite_) [AbstractMessage.Builder.newUninitializedMessageException(Message)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.Builder.html#com_google_protobuf_AbstractMessage_Builder_newUninitializedMessageException_com_google_protobuf_Message_) [AbstractMessage.Builder.toString()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.Builder.html#com_google_protobuf_AbstractMessage_Builder_toString__) [AbstractMessageLite.Builder.\<T\>addAll(Iterable\<T\>,Collection\<? super T\>)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessageLite.Builder.html#com_google_protobuf_AbstractMessageLite_Builder__T_addAll_java_lang_Iterable_T__java_util_Collection___super_T__) [AbstractMessageLite.Builder.\<T\>addAll(Iterable\<T\>,List\<? super T\>)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessageLite.Builder.html#com_google_protobuf_AbstractMessageLite_Builder__T_addAll_java_lang_Iterable_T__java_util_List___super_T__) [AbstractMessageLite.Builder.internalMergeFrom(MessageType)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessageLite.Builder.html#com_google_protobuf_AbstractMessageLite_Builder_internalMergeFrom_MessageType_) [AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessageLite.Builder.html#com_google_protobuf_AbstractMessageLite_Builder_mergeDelimitedFrom_java_io_InputStream_) [AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessageLite.Builder.html#com_google_protobuf_AbstractMessageLite_Builder_mergeDelimitedFrom_java_io_InputStream_com_google_protobuf_ExtensionRegistryLite_) [AbstractMessageLite.Builder.mergeFrom(MessageLite)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessageLite.Builder.html#com_google_protobuf_AbstractMessageLite_Builder_mergeFrom_com_google_protobuf_MessageLite_) [AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessageLite.Builder.html#com_google_protobuf_AbstractMessageLite_Builder_newUninitializedMessageException_com_google_protobuf_MessageLite_) [GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_addRepeatedField_com_google_protobuf_Descriptors_FieldDescriptor_java_lang_Object_) [GeneratedMessage.Builder.clear()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_clear__) [GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_clearField_com_google_protobuf_Descriptors_FieldDescriptor_) [GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_clearOneof_com_google_protobuf_Descriptors_OneofDescriptor_) [GeneratedMessage.Builder.clone()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_clone__) [GeneratedMessage.Builder.getAllFields()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_getAllFields__) [GeneratedMessage.Builder.getDescriptorForType()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_getDescriptorForType__) [GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_getField_com_google_protobuf_Descriptors_FieldDescriptor_) [GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_getFieldBuilder_com_google_protobuf_Descriptors_FieldDescriptor_) [GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_getOneofFieldDescriptor_com_google_protobuf_Descriptors_OneofDescriptor_) [GeneratedMessage.Builder.getParentForChildren()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_getParentForChildren__) [GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_getRepeatedField_com_google_protobuf_Descriptors_FieldDescriptor_int_) [GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_getRepeatedFieldBuilder_com_google_protobuf_Descriptors_FieldDescriptor_int_) [GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_getRepeatedFieldCount_com_google_protobuf_Descriptors_FieldDescriptor_) com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder() [GeneratedMessage.Builder.getUnknownFields()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_getUnknownFields__) [GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_hasField_com_google_protobuf_Descriptors_FieldDescriptor_) [GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_hasOneof_com_google_protobuf_Descriptors_OneofDescriptor_) [GeneratedMessage.Builder.internalGetFieldAccessorTable()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_internalGetFieldAccessorTable__) [GeneratedMessage.Builder.internalGetMapField(int)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_internalGetMapField_int_) com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int) [GeneratedMessage.Builder.internalGetMutableMapField(int)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_internalGetMutableMapField_int_) com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int) [GeneratedMessage.Builder.isClean()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_isClean__) [GeneratedMessage.Builder.isInitialized()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_isInitialized__) [GeneratedMessage.Builder.markClean()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_markClean__) [GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_mergeUnknownFields_com_google_protobuf_UnknownFieldSet_) com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString) com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int) [GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_newBuilderForField_com_google_protobuf_Descriptors_FieldDescriptor_) [GeneratedMessage.Builder.onBuilt()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_onBuilt__) [GeneratedMessage.Builder.onChanged()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_onChanged__) com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int) [GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_setField_com_google_protobuf_Descriptors_FieldDescriptor_java_lang_Object_) [GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_setRepeatedField_com_google_protobuf_Descriptors_FieldDescriptor_int_java_lang_Object_) com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder) [GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_setUnknownFields_com_google_protobuf_UnknownFieldSet_) com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet) [Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-) [Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) [Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) [Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--) [Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) [Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) [Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) [Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) [Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)

## Static Methods

### getDescriptor()

    public static final Descriptors.Descriptor getDescriptor()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Descriptors.Descriptor.html` |   |

## Methods

### build()

    public LogMetric build()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.LogMetric` |   |

### buildPartial()

    public LogMetric buildPartial()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.LogMetric` |   |

### clear()

    public LogMetric.Builder clear()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.LogMetric.Builder` |   |

**Overrides** [GeneratedMessage.Builder\<BuilderType\>.clear()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.LogMetric.Builder` | This builder for chaining. |

### clearFilter()

    public LogMetric.Builder clearFilter()

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.LogMetric.Builder` | This builder for chaining. |

### clearLabelExtractors()

    public LogMetric.Builder clearLabelExtractors()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.LogMetric.Builder` | This builder for chaining. |

### 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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.LogMetric.Builder` | This builder for chaining. |

### 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` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Timestamp.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Timestamp.Builder.html` |   |

### 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.TimestampOrBuilder.html` |   |

### getDefaultInstanceForType()

    public LogMetric getDefaultInstanceForType()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for description. |

### getDescriptorForType()

    public Descriptors.Descriptor getDescriptorForType()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Descriptors.Descriptor.html` |   |

**Overrides** [GeneratedMessage.Builder\<BuilderType\>.getDescriptorForType()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The disabled. |

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The filter. |

### getFilterBytes()

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for filter. |

### getLabelExtractors() (deprecated)

    public Map<String,String> getLabelExtractors()

Use [#getLabelExtractorsMap()](https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.LogMetric.Builder#com_google_logging_v2_LogMetric_Builder_getLabelExtractorsMap__) instead.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/Map.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html,https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` |   |

### 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/Map.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html,https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` |   |

### 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` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |
| `defaultValue` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |   |

### 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` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |   |

### 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() (deprecated)

    public Map<String,String> getMutableLabelExtractors()

Use alternate mutation accessors instead.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/Map.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html,https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` |   |

### 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Timestamp.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Timestamp.Builder.html` |   |

### 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.TimestampOrBuilder.html` |   |

### 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | 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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the updateTime field is set. |

### internalGetFieldAccessorTable()

    protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.FieldAccessorTable.html` |   |

**Overrides** [GeneratedMessage.Builder\<BuilderType\>.internalGetFieldAccessorTable()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_internalGetFieldAccessorTable__)

### internalGetMapFieldReflection(int number)

    protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `number` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.protobuf.MapFieldReflectionAccessor` |   |

**Overrides** com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

### internalGetMutableMapFieldReflection(int number)

    protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `number` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.protobuf.MapFieldReflectionAccessor` |   |

**Overrides** com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

### isInitialized()

    public final boolean isInitialized()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

**Overrides** [GeneratedMessage.Builder\<BuilderType\>.isInitialized()](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.GeneratedMessage.Builder.html#com_google_protobuf_GeneratedMessage_Builder_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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Timestamp.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.LogMetric.Builder` |   |

### mergeFrom(LogMetric other)

    public LogMetric.Builder mergeFrom(LogMetric other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.LogMetric` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.LogMetric.Builder` |   |

### mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `input` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.CodedInputStream.html` |
| `extensionRegistry` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ExtensionRegistryLite.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.LogMetric.Builder` |   |

**Overrides** [AbstractMessage.Builder\<BuilderType\>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.Builder.html#com_google_protobuf_AbstractMessage_Builder_mergeFrom_com_google_protobuf_CodedInputStream_com_google_protobuf_ExtensionRegistryLite_)

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` |   |

### mergeFrom(Message other)

    public LogMetric.Builder mergeFrom(Message other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Message.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.LogMetric.Builder` |   |

**Overrides** [AbstractMessage.Builder\<BuilderType\>.mergeFrom(Message other)](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.AbstractMessage.Builder.html#com_google_protobuf_AbstractMessage_Builder_mergeFrom_com_google_protobuf_Message_)

### 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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.LogMetric.Builder` |   |

### 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` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Timestamp.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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` | `https://docs.oracle.com/javase/8/docs/api/java/util/Map.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html,https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |
| `value` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` The bucketName to set. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` The bytes for bucketName to set. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Timestamp.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Timestamp.Builder.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` The description to set. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` The bytes for description to set. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` The disabled to set. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.LogMetric.Builder` | This builder for chaining. |

### setFilter(String value)

    public LogMetric.Builder setFilter(String value)

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` The filter to set. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.LogMetric.Builder` | This builder for chaining. |

### setFilterBytes(ByteString value)

    public LogMetric.Builder setFilterBytes(ByteString value)

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` The bytes for filter to set. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` The name to set. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` The bytes for name to set. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.LogMetric.Builder` | This builder for chaining. |

### 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` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Timestamp.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Timestamp.Builder.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` The valueExtractor to set. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` The bytes for valueExtractor to set. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.LogMetric.ApiVersion` The version to set. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.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` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` The enum numeric value on the wire for version to set. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-logging/latest/com.google.logging.v2.LogMetric.Builder` | This builder for chaining. |