Class DashboardFilter (2.8.0)

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

Static Fields

FILTER_TYPE_FIELD_NUMBER

public static final int FILTER_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

LABEL_KEY_FIELD_NUMBER

public static final int LABEL_KEY_FIELD_NUMBER
Field Value
TypeDescription
int

STRING_VALUE_FIELD_NUMBER

public static final int STRING_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

TEMPLATE_VARIABLE_FIELD_NUMBER

public static final int TEMPLATE_VARIABLE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DashboardFilter getDefaultInstance()
Returns
TypeDescription
DashboardFilter

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static DashboardFilter.Builder newBuilder()
Returns
TypeDescription
DashboardFilter.Builder

newBuilder(DashboardFilter prototype)

public static DashboardFilter.Builder newBuilder(DashboardFilter prototype)
Parameter
NameDescription
prototypeDashboardFilter
Returns
TypeDescription
DashboardFilter.Builder

parseDelimitedFrom(InputStream input)

public static DashboardFilter parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DashboardFilter
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DashboardFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DashboardFilter
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DashboardFilter parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DashboardFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DashboardFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DashboardFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DashboardFilter parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DashboardFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DashboardFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DashboardFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DashboardFilter parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DashboardFilter
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DashboardFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DashboardFilter
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DashboardFilter parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DashboardFilter
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DashboardFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DashboardFilter
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DashboardFilter parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DashboardFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DashboardFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DashboardFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DashboardFilter> parser()
Returns
TypeDescription
Parser<DashboardFilter>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public DashboardFilter getDefaultInstanceForType()
Returns
TypeDescription
DashboardFilter

getDefaultValueCase()

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

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.

getParserForType()

public Parser<DashboardFilter> getParserForType()
Returns
TypeDescription
Parser<DashboardFilter>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasStringValue()

public boolean hasStringValue()

A variable-length string value.

string string_value = 4;

Returns
TypeDescription
boolean

Whether the stringValue field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DashboardFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DashboardFilter.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException