Class DashboardFilter.Builder (2.8.0)

Stay organized with collections Save and categorize content based on your preferences.
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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DashboardFilter.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DashboardFilter.Builder
Overrides

build()

public DashboardFilter build()
Returns
TypeDescription
DashboardFilter

buildPartial()

public DashboardFilter buildPartial()
Returns
TypeDescription
DashboardFilter

clear()

public DashboardFilter.Builder clear()
Returns
TypeDescription
DashboardFilter.Builder
Overrides

clearDefaultValue()

public DashboardFilter.Builder clearDefaultValue()
Returns
TypeDescription
DashboardFilter.Builder

clearField(Descriptors.FieldDescriptor field)

public DashboardFilter.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
DashboardFilter.Builder
Overrides

clearFilterType()

public DashboardFilter.Builder clearFilterType()

The specified filter type

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

Returns
TypeDescription
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
TypeDescription
DashboardFilter.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DashboardFilter.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
DashboardFilter.Builder
Overrides

clearStringValue()

public DashboardFilter.Builder clearStringValue()

A variable-length string value.

string string_value = 4;

Returns
TypeDescription
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
TypeDescription
DashboardFilter.Builder

This builder for chaining.

clone()

public DashboardFilter.Builder clone()
Returns
TypeDescription
DashboardFilter.Builder
Overrides

getDefaultInstanceForType()

public DashboardFilter getDefaultInstanceForType()
Returns
TypeDescription
DashboardFilter

getDefaultValueCase()

public DashboardFilter.DefaultValueCase getDefaultValueCase()
Returns
TypeDescription
DashboardFilter.DefaultValueCase

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilterType()

public DashboardFilter.FilterType getFilterType()

The specified filter type

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

Returns
TypeDescription
DashboardFilter.FilterType

The filterType.

getFilterTypeValue()

public int getFilterTypeValue()

The specified filter type

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

Returns
TypeDescription
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
TypeDescription
String

The labelKey.

getLabelKeyBytes()

public ByteString getLabelKeyBytes()

Required. The key for the label

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

Returns
TypeDescription
ByteString

The bytes for labelKey.

getStringValue()

public String getStringValue()

A variable-length string value.

string string_value = 4;

Returns
TypeDescription
String

The stringValue.

getStringValueBytes()

public ByteString getStringValueBytes()

A variable-length string value.

string string_value = 4;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for templateVariable.

hasStringValue()

public boolean hasStringValue()

A variable-length string value.

string string_value = 4;

Returns
TypeDescription
boolean

Whether the stringValue field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(DashboardFilter other)

public DashboardFilter.Builder mergeFrom(DashboardFilter other)
Parameter
NameDescription
otherDashboardFilter
Returns
TypeDescription
DashboardFilter.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DashboardFilter.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DashboardFilter.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public DashboardFilter.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
DashboardFilter.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DashboardFilter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DashboardFilter.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public DashboardFilter.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueDashboardFilter.FilterType

The filterType to set.

Returns
TypeDescription
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
NameDescription
valueint

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

Returns
TypeDescription
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
NameDescription
valueString

The labelKey to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for labelKey to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
DashboardFilter.Builder
Overrides

setStringValue(String value)

public DashboardFilter.Builder setStringValue(String value)

A variable-length string value.

string string_value = 4;

Parameter
NameDescription
valueString

The stringValue to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for stringValue to set.

Returns
TypeDescription
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
NameDescription
valueString

The templateVariable to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for templateVariable to set.

Returns
TypeDescription
DashboardFilter.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DashboardFilter.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DashboardFilter.Builder
Overrides