Class AlertPolicy.Condition.LogMatch.Builder (3.46.0)

public static final class AlertPolicy.Condition.LogMatch.Builder extends GeneratedMessageV3.Builder<AlertPolicy.Condition.LogMatch.Builder> implements AlertPolicy.Condition.LogMatchOrBuilder

A condition type that checks whether a log message in the scoping project satisfies the given filter. Logs from other projects in the metrics scope are not evaluated.

Protobuf type google.monitoring.v3.AlertPolicy.Condition.LogMatch

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AlertPolicy.Condition.LogMatch.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AlertPolicy.Condition.LogMatch.Builder
Overrides

build()

public AlertPolicy.Condition.LogMatch build()
Returns
Type Description
AlertPolicy.Condition.LogMatch

buildPartial()

public AlertPolicy.Condition.LogMatch buildPartial()
Returns
Type Description
AlertPolicy.Condition.LogMatch

clear()

public AlertPolicy.Condition.LogMatch.Builder clear()
Returns
Type Description
AlertPolicy.Condition.LogMatch.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public AlertPolicy.Condition.LogMatch.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AlertPolicy.Condition.LogMatch.Builder
Overrides

clearFilter()

public AlertPolicy.Condition.LogMatch.Builder clearFilter()

Required. A logs-based filter. See Advanced Logs Queries for how this filter should be constructed.

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

Returns
Type Description
AlertPolicy.Condition.LogMatch.Builder

This builder for chaining.

clearLabelExtractors()

public AlertPolicy.Condition.LogMatch.Builder clearLabelExtractors()
Returns
Type Description
AlertPolicy.Condition.LogMatch.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public AlertPolicy.Condition.LogMatch.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AlertPolicy.Condition.LogMatch.Builder
Overrides

clone()

public AlertPolicy.Condition.LogMatch.Builder clone()
Returns
Type Description
AlertPolicy.Condition.LogMatch.Builder
Overrides

containsLabelExtractors(String key)

public boolean containsLabelExtractors(String key)

Optional. A map from a label key to an extractor expression, which is used to extract the value for this label key. Each entry in this map is a specification for how data should be extracted from log entries that match filter. Each combination of extracted values is treated as a separate rule for the purposes of triggering notifications. Label keys and corresponding values can be used in notifications generated by this condition.

Please see the documentation on logs-based metric valueExtractors for syntax and examples.

map<string, string> label_extractors = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

getDefaultInstanceForType()

public AlertPolicy.Condition.LogMatch getDefaultInstanceForType()
Returns
Type Description
AlertPolicy.Condition.LogMatch

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

public String getFilter()

Required. A logs-based filter. See Advanced Logs Queries for how this filter should be constructed.

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Required. A logs-based filter. See Advanced Logs Queries for how this filter should be constructed.

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

Returns
Type Description
ByteString

The bytes for filter.

getLabelExtractors() (deprecated)

public Map<String,String> getLabelExtractors()
Returns
Type Description
Map<String,String>

getLabelExtractorsCount()

public int getLabelExtractorsCount()

Optional. A map from a label key to an extractor expression, which is used to extract the value for this label key. Each entry in this map is a specification for how data should be extracted from log entries that match filter. Each combination of extracted values is treated as a separate rule for the purposes of triggering notifications. Label keys and corresponding values can be used in notifications generated by this condition.

Please see the documentation on logs-based metric valueExtractors for syntax and examples.

map<string, string> label_extractors = 2;

Returns
Type Description
int

getLabelExtractorsMap()

public Map<String,String> getLabelExtractorsMap()

Optional. A map from a label key to an extractor expression, which is used to extract the value for this label key. Each entry in this map is a specification for how data should be extracted from log entries that match filter. Each combination of extracted values is treated as a separate rule for the purposes of triggering notifications. Label keys and corresponding values can be used in notifications generated by this condition.

Please see the documentation on logs-based metric valueExtractors for syntax and examples.

map<string, string> label_extractors = 2;

Returns
Type Description
Map<String,String>

getLabelExtractorsOrDefault(String key, String defaultValue)

public String getLabelExtractorsOrDefault(String key, String defaultValue)

Optional. A map from a label key to an extractor expression, which is used to extract the value for this label key. Each entry in this map is a specification for how data should be extracted from log entries that match filter. Each combination of extracted values is treated as a separate rule for the purposes of triggering notifications. Label keys and corresponding values can be used in notifications generated by this condition.

Please see the documentation on logs-based metric valueExtractors for syntax and examples.

map<string, string> label_extractors = 2;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelExtractorsOrThrow(String key)

public String getLabelExtractorsOrThrow(String key)

Optional. A map from a label key to an extractor expression, which is used to extract the value for this label key. Each entry in this map is a specification for how data should be extracted from log entries that match filter. Each combination of extracted values is treated as a separate rule for the purposes of triggering notifications. Label keys and corresponding values can be used in notifications generated by this condition.

Please see the documentation on logs-based metric valueExtractors for syntax and examples.

map<string, string> label_extractors = 2;

Parameter
Name Description
key String
Returns
Type Description
String

getMutableLabelExtractors() (deprecated)

public Map<String,String> getMutableLabelExtractors()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AlertPolicy.Condition.LogMatch other)

public AlertPolicy.Condition.LogMatch.Builder mergeFrom(AlertPolicy.Condition.LogMatch other)
Parameter
Name Description
other AlertPolicy.Condition.LogMatch
Returns
Type Description
AlertPolicy.Condition.LogMatch.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AlertPolicy.Condition.LogMatch.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AlertPolicy.Condition.LogMatch.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AlertPolicy.Condition.LogMatch.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AlertPolicy.Condition.LogMatch.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AlertPolicy.Condition.LogMatch.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AlertPolicy.Condition.LogMatch.Builder
Overrides

putAllLabelExtractors(Map<String,String> values)

public AlertPolicy.Condition.LogMatch.Builder putAllLabelExtractors(Map<String,String> values)

Optional. A map from a label key to an extractor expression, which is used to extract the value for this label key. Each entry in this map is a specification for how data should be extracted from log entries that match filter. Each combination of extracted values is treated as a separate rule for the purposes of triggering notifications. Label keys and corresponding values can be used in notifications generated by this condition.

Please see the documentation on logs-based metric valueExtractors for syntax and examples.

map<string, string> label_extractors = 2;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
AlertPolicy.Condition.LogMatch.Builder

putLabelExtractors(String key, String value)

public AlertPolicy.Condition.LogMatch.Builder putLabelExtractors(String key, String value)

Optional. A map from a label key to an extractor expression, which is used to extract the value for this label key. Each entry in this map is a specification for how data should be extracted from log entries that match filter. Each combination of extracted values is treated as a separate rule for the purposes of triggering notifications. Label keys and corresponding values can be used in notifications generated by this condition.

Please see the documentation on logs-based metric valueExtractors for syntax and examples.

map<string, string> label_extractors = 2;

Parameters
Name Description
key String
value String
Returns
Type Description
AlertPolicy.Condition.LogMatch.Builder

removeLabelExtractors(String key)

public AlertPolicy.Condition.LogMatch.Builder removeLabelExtractors(String key)

Optional. A map from a label key to an extractor expression, which is used to extract the value for this label key. Each entry in this map is a specification for how data should be extracted from log entries that match filter. Each combination of extracted values is treated as a separate rule for the purposes of triggering notifications. Label keys and corresponding values can be used in notifications generated by this condition.

Please see the documentation on logs-based metric valueExtractors for syntax and examples.

map<string, string> label_extractors = 2;

Parameter
Name Description
key String
Returns
Type Description
AlertPolicy.Condition.LogMatch.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public AlertPolicy.Condition.LogMatch.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AlertPolicy.Condition.LogMatch.Builder
Overrides

setFilter(String value)

public AlertPolicy.Condition.LogMatch.Builder setFilter(String value)

Required. A logs-based filter. See Advanced Logs Queries for how this filter should be constructed.

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
AlertPolicy.Condition.LogMatch.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public AlertPolicy.Condition.LogMatch.Builder setFilterBytes(ByteString value)

Required. A logs-based filter. See Advanced Logs Queries for how this filter should be constructed.

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
AlertPolicy.Condition.LogMatch.Builder

This builder for chaining.

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

public AlertPolicy.Condition.LogMatch.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AlertPolicy.Condition.LogMatch.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final AlertPolicy.Condition.LogMatch.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AlertPolicy.Condition.LogMatch.Builder
Overrides