public static final class LogMetric.Builder extends GeneratedMessageV3.Builder<LogMetric.Builder> implements LogMetricOrBuilderDescribes 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.BuilderImplements
LogMetricOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public LogMetric.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| LogMetric.Builder |
build()
public LogMetric build()| Type | Description |
| LogMetric |
buildPartial()
public LogMetric buildPartial()| Type | Description |
| LogMetric |
clear()
public LogMetric.Builder clear()| Type | Description |
| LogMetric.Builder |
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];
| 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];
| 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];
| 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];
| Type | Description |
| LogMetric.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public LogMetric.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| LogMetric.Builder |
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];
| Type | Description |
| LogMetric.Builder | This builder for chaining. |
clearLabelExtractors()
public LogMetric.Builder clearLabelExtractors()| 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];
| 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];
| Type | Description |
| LogMetric.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public LogMetric.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| LogMetric.Builder |
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];
| 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 argument are:
- field: The name of the log entry field from which the value is to be extracted.
- 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];
| 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=220
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];
| Type | Description |
| LogMetric.Builder | This builder for chaining. |
clone()
public LogMetric.Builder clone()| Type | Description |
| LogMetric.Builder |
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 the either the extraction or the type conversion fails,
the label will have a default value. The default value for a string
label is an empty string, for an integer label its 0, and for a boolean
label its false.
Note that there are upper bounds on the maximum number of labels and the
number of active time series that are allowed in a project.
map<string, string> label_extractors = 7 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| key | String |
| Type | Description |
| boolean |
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];
| 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];
| 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];
| 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];
| 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];
| 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];
| Type | Description |
| TimestampOrBuilder |
getDefaultInstanceForType()
public LogMetric getDefaultInstanceForType()| 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];
| 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];
| Type | Description |
| ByteString | The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
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];
| 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];
| 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];
| Type | Description |
| ByteString | The bytes for filter. |
getLabelExtractors()
public Map<String,String> getLabelExtractors()Use #getLabelExtractorsMap() instead.
| 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 the either the extraction or the type conversion fails,
the label will have a default value. The default value for a string
label is an empty string, for an integer label its 0, and for a boolean
label its false.
Note that there are upper bounds on the maximum number of labels and the
number of active time series that are allowed in a project.
map<string, string> label_extractors = 7 [(.google.api.field_behavior) = OPTIONAL];
| 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 the either the extraction or the type conversion fails,
the label will have a default value. The default value for a string
label is an empty string, for an integer label its 0, and for a boolean
label its false.
Note that there are upper bounds on the maximum number of labels and the
number of active time series that are allowed in a project.
map<string, string> label_extractors = 7 [(.google.api.field_behavior) = OPTIONAL];
| 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 the either the extraction or the type conversion fails,
the label will have a default value. The default value for a string
label is an empty string, for an integer label its 0, and for a boolean
label its false.
Note that there are upper bounds on the maximum number of labels and the
number of active time series that are allowed in a project.
map<string, string> label_extractors = 7 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| key | String |
| defaultValue | String |
| 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 the either the extraction or the type conversion fails,
the label will have a default value. The default value for a string
label is an empty string, for an integer label its 0, and for a boolean
label its false.
Note that there are upper bounds on the maximum number of labels and the
number of active time series that are allowed in a project.
map<string, string> label_extractors = 7 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| key | String |
| 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];
| 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];
| 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];
| Type | Description |
| com.google.api.MetricDescriptorOrBuilder |
getMutableLabelExtractors()
public Map<String,String> getMutableLabelExtractors()Use alternate mutation accessors instead.
| 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];
| 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];
| 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];
| 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];
| 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];
| 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 argument are:
- field: The name of the log entry field from which the value is to be extracted.
- 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];
| 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 argument are:
- field: The name of the log entry field from which the value is to be extracted.
- 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];
| 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=220
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];
| 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=220
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];
| 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];
| 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];
| 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];
| 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];
| Type | Description |
| boolean | Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Name | Description |
| number | int |
| Type | Description |
| MapField |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Name | Description |
| number | int |
| Type | Description |
| MapField |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
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];
| Name | Description |
| value | com.google.api.Distribution.BucketOptions |
| 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];
| Name | Description |
| value | Timestamp |
| Type | Description |
| LogMetric.Builder |
mergeFrom(LogMetric other)
public LogMetric.Builder mergeFrom(LogMetric other)| Name | Description |
| other | LogMetric |
| Type | Description |
| LogMetric.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public LogMetric.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| LogMetric.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public LogMetric.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| LogMetric.Builder |
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];
| Name | Description |
| value | com.google.api.MetricDescriptor |
| Type | Description |
| LogMetric.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final LogMetric.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| 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];
| Name | Description |
| value | Timestamp |
| 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 the either the extraction or the type conversion fails,
the label will have a default value. The default value for a string
label is an empty string, for an integer label its 0, and for a boolean
label its false.
Note that there are upper bounds on the maximum number of labels and the
number of active time series that are allowed in a project.
map<string, string> label_extractors = 7 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| values | Map<String,String> |
| 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 the either the extraction or the type conversion fails,
the label will have a default value. The default value for a string
label is an empty string, for an integer label its 0, and for a boolean
label its false.
Note that there are upper bounds on the maximum number of labels and the
number of active time series that are allowed in a project.
map<string, string> label_extractors = 7 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| key | String |
| value | String |
| 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 the either the extraction or the type conversion fails,
the label will have a default value. The default value for a string
label is an empty string, for an integer label its 0, and for a boolean
label its false.
Note that there are upper bounds on the maximum number of labels and the
number of active time series that are allowed in a project.
map<string, string> label_extractors = 7 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| key | String |
| Type | Description |
| LogMetric.Builder |
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];
| Name | Description |
| value | com.google.api.Distribution.BucketOptions |
| 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];
| Name | Description |
| builderForValue | com.google.api.Distribution.BucketOptions.Builder |
| 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];
| Name | Description |
| value | Timestamp |
| 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];
| Name | Description |
| builderForValue | Builder |
| 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];
| Name | Description |
| value | StringThe description to set. |
| 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];
| Name | Description |
| value | ByteStringThe bytes for description to set. |
| 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];
| Name | Description |
| value | booleanThe disabled to set. |
| Type | Description |
| LogMetric.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public LogMetric.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| LogMetric.Builder |
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];
| Name | Description |
| value | StringThe filter to set. |
| 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];
| Name | Description |
| value | ByteStringThe bytes for filter to set. |
| 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];
| Name | Description |
| value | com.google.api.MetricDescriptor |
| 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];
| Name | Description |
| builderForValue | com.google.api.MetricDescriptor.Builder |
| 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];
| Name | Description |
| value | StringThe name to set. |
| 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];
| Name | Description |
| value | ByteStringThe bytes for name to set. |
| 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)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| LogMetric.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final LogMetric.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| LogMetric.Builder |
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];
| Name | Description |
| value | Timestamp |
| 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];
| Name | Description |
| builderForValue | Builder |
| 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 argument are:
- field: The name of the log entry field from which the value is to be extracted.
- 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];
| Name | Description |
| value | StringThe valueExtractor to set. |
| 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 argument are:
- field: The name of the log entry field from which the value is to be extracted.
- 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];
| Name | Description |
| value | ByteStringThe bytes for valueExtractor to set. |
| 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=220
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];
| Name | Description |
| value | LogMetric.ApiVersionThe version to set. |
| 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=220
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];
| Name | Description |
| value | intThe enum numeric value on the wire for version to set. |
| Type | Description |
| LogMetric.Builder | This builder for chaining. |