Class DashboardFilter (2.55.0) 

public final class DashboardFilter extends GeneratedMessageV3 implements DashboardFilterOrBuilder

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

Protobuf type google.monitoring.dashboard.v1.DashboardFilter

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DashboardFilter

Static Fields

FILTER_TYPE_FIELD_NUMBER

public static final int FILTER_TYPE_FIELD_NUMBER
Field Value
Type Description
int

LABEL_KEY_FIELD_NUMBER

public static final int LABEL_KEY_FIELD_NUMBER
Field Value
Type Description
int

STRING_VALUE_FIELD_NUMBER

public static final int STRING_VALUE_FIELD_NUMBER
Field Value
Type Description
int

TEMPLATE_VARIABLE_FIELD_NUMBER

public static final int TEMPLATE_VARIABLE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DashboardFilter getDefaultInstance()
Returns
Type Description
DashboardFilter

getDescriptor()

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

newBuilder()

public static DashboardFilter.Builder newBuilder()
Returns
Type Description
DashboardFilter.Builder

newBuilder(DashboardFilter prototype)

public static DashboardFilter.Builder newBuilder(DashboardFilter prototype)
Parameter
Name Description
prototype DashboardFilter
Returns
Type Description
DashboardFilter.Builder

parseDelimitedFrom(InputStream input)

public static DashboardFilter parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DashboardFilter
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DashboardFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DashboardFilter
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DashboardFilter parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DashboardFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DashboardFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DashboardFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DashboardFilter parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DashboardFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DashboardFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DashboardFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DashboardFilter parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DashboardFilter
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DashboardFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DashboardFilter
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DashboardFilter parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DashboardFilter
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DashboardFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DashboardFilter
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DashboardFilter parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DashboardFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DashboardFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DashboardFilter
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DashboardFilter> parser()
Returns
Type Description
Parser<DashboardFilter>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public DashboardFilter getDefaultInstanceForType()
Returns
Type Description
DashboardFilter

getDefaultValueCase()

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

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.

getParserForType()

public Parser<DashboardFilter> getParserForType()
Returns
Type Description
Parser<DashboardFilter>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DashboardFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DashboardFilter.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException