Class DashboardFilter.Builder (2.46.0)

public static final class DashboardFilter.Builder extends GeneratedMessageV3.Builder<DashboardFilter.Builder> implements DashboardFilterOrBuilder

A filter to reduce the amount of data charted in relevant widgets.

Protobuf type google.monitoring.dashboard.v1.DashboardFilter

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public DashboardFilter build()
Returns
Type Description
DashboardFilter

buildPartial()

public DashboardFilter buildPartial()
Returns
Type Description
DashboardFilter

clear()

public DashboardFilter.Builder clear()
Returns
Type Description
DashboardFilter.Builder
Overrides

clearDefaultValue()

public DashboardFilter.Builder clearDefaultValue()
Returns
Type Description
DashboardFilter.Builder

clearField(Descriptors.FieldDescriptor field)

public DashboardFilter.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DashboardFilter.Builder
Overrides

clearFilterType()

public DashboardFilter.Builder clearFilterType()

The specified filter type

.google.monitoring.dashboard.v1.DashboardFilter.FilterType filter_type = 5;

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

clearLabelKey()

public DashboardFilter.Builder clearLabelKey()

Required. The key for the label

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

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DashboardFilter.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DashboardFilter.Builder
Overrides

clearStringValue()

public DashboardFilter.Builder clearStringValue()

A variable-length string value.

string string_value = 4;

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

clearTemplateVariable()

public DashboardFilter.Builder clearTemplateVariable()

The placeholder text that can be referenced in a filter string or MQL query. If omitted, the dashboard filter will be applied to all relevant widgets in the dashboard.

string template_variable = 3;

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

clone()

public DashboardFilter.Builder clone()
Returns
Type Description
DashboardFilter.Builder
Overrides

getDefaultInstanceForType()

public DashboardFilter getDefaultInstanceForType()
Returns
Type Description
DashboardFilter

getDefaultValueCase()

public DashboardFilter.DefaultValueCase getDefaultValueCase()
Returns
Type Description
DashboardFilter.DefaultValueCase

getDescriptorForType()

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

getFilterType()

public DashboardFilter.FilterType getFilterType()

The specified filter type

.google.monitoring.dashboard.v1.DashboardFilter.FilterType filter_type = 5;

Returns
Type Description
DashboardFilter.FilterType

The filterType.

getFilterTypeValue()

public int getFilterTypeValue()

The specified filter type

.google.monitoring.dashboard.v1.DashboardFilter.FilterType filter_type = 5;

Returns
Type Description
int

The enum numeric value on the wire for filterType.

getLabelKey()

public String getLabelKey()

Required. The key for the label

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

Returns
Type Description
String

The labelKey.

getLabelKeyBytes()

public ByteString getLabelKeyBytes()

Required. The key for the label

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

Returns
Type Description
ByteString

The bytes for labelKey.

getStringValue()

public String getStringValue()

A variable-length string value.

string string_value = 4;

Returns
Type Description
String

The stringValue.

getStringValueBytes()

public ByteString getStringValueBytes()

A variable-length string value.

string string_value = 4;

Returns
Type Description
ByteString

The bytes for stringValue.

getTemplateVariable()

public String getTemplateVariable()

The placeholder text that can be referenced in a filter string or MQL query. If omitted, the dashboard filter will be applied to all relevant widgets in the dashboard.

string template_variable = 3;

Returns
Type Description
String

The templateVariable.

getTemplateVariableBytes()

public ByteString getTemplateVariableBytes()

The placeholder text that can be referenced in a filter string or MQL query. If omitted, the dashboard filter will be applied to all relevant widgets in the dashboard.

string template_variable = 3;

Returns
Type Description
ByteString

The bytes for templateVariable.

hasStringValue()

public boolean hasStringValue()

A variable-length string value.

string string_value = 4;

Returns
Type Description
boolean

Whether the stringValue field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DashboardFilter other)

public DashboardFilter.Builder mergeFrom(DashboardFilter other)
Parameter
Name Description
other DashboardFilter
Returns
Type Description
DashboardFilter.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public DashboardFilter.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DashboardFilter.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DashboardFilter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DashboardFilter.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilterType(DashboardFilter.FilterType value)

public DashboardFilter.Builder setFilterType(DashboardFilter.FilterType value)

The specified filter type

.google.monitoring.dashboard.v1.DashboardFilter.FilterType filter_type = 5;

Parameter
Name Description
value DashboardFilter.FilterType

The filterType to set.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

setFilterTypeValue(int value)

public DashboardFilter.Builder setFilterTypeValue(int value)

The specified filter type

.google.monitoring.dashboard.v1.DashboardFilter.FilterType filter_type = 5;

Parameter
Name Description
value int

The enum numeric value on the wire for filterType to set.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

setLabelKey(String value)

public DashboardFilter.Builder setLabelKey(String value)

Required. The key for the label

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

Parameter
Name Description
value String

The labelKey to set.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

setLabelKeyBytes(ByteString value)

public DashboardFilter.Builder setLabelKeyBytes(ByteString value)

Required. The key for the label

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

Parameter
Name Description
value ByteString

The bytes for labelKey to set.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

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

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

setStringValue(String value)

public DashboardFilter.Builder setStringValue(String value)

A variable-length string value.

string string_value = 4;

Parameter
Name Description
value String

The stringValue to set.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

setStringValueBytes(ByteString value)

public DashboardFilter.Builder setStringValueBytes(ByteString value)

A variable-length string value.

string string_value = 4;

Parameter
Name Description
value ByteString

The bytes for stringValue to set.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

setTemplateVariable(String value)

public DashboardFilter.Builder setTemplateVariable(String value)

The placeholder text that can be referenced in a filter string or MQL query. If omitted, the dashboard filter will be applied to all relevant widgets in the dashboard.

string template_variable = 3;

Parameter
Name Description
value String

The templateVariable to set.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

setTemplateVariableBytes(ByteString value)

public DashboardFilter.Builder setTemplateVariableBytes(ByteString value)

The placeholder text that can be referenced in a filter string or MQL query. If omitted, the dashboard filter will be applied to all relevant widgets in the dashboard.

string template_variable = 3;

Parameter
Name Description
value ByteString

The bytes for templateVariable to set.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DashboardFilter.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DashboardFilter.Builder
Overrides