Class DashboardFilter (2.16.0)
2.93.0 (latest)
2.90.0
2.89.0
2.87.0
2.85.0
2.84.0
2.82.0
2.80.0
2.78.0
2.77.0
2.76.0
2.75.0
2.74.0
2.72.0
2.70.0
2.69.0
2.66.0
2.65.0
2.64.0
2.62.0
2.61.0
2.60.0
2.59.0
2.58.0
2.57.0
2.56.0
2.55.0
2.54.0
2.53.0
2.51.0
2.50.0
2.49.0
2.48.0
2.47.0
2.46.0
2.45.0
2.44.0
2.43.0
2.42.0
2.41.0
2.39.0
2.38.0
2.37.0
2.36.0
2.35.0
2.34.0
2.33.0
2.32.0
2.31.0
2.30.0
2.29.0
2.26.0
2.25.0
2.24.0
2.23.0
2.22.0
2.21.0
2.20.0
2.19.0
2.18.0
2.17.0
2.16.0
2.15.0
2.14.0
2.13.0
2.11.0
2.10.0
2.9.0
2.8.0
2.7.0
2.6.0
2.5.6
2.4.0
2.3.0
2.2.6
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
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static DashboardFilter . Builder newBuilder ()
newBuilder(DashboardFilter prototype)
public static DashboardFilter . Builder newBuilder ( DashboardFilter prototype )
public static DashboardFilter parseDelimitedFrom ( InputStream input )
public static DashboardFilter parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static DashboardFilter parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DashboardFilter parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static DashboardFilter parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DashboardFilter parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static DashboardFilter parseFrom ( CodedInputStream input )
public static DashboardFilter parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static DashboardFilter parseFrom ( InputStream input )
public static DashboardFilter parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static DashboardFilter parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DashboardFilter parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<DashboardFilter> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
Overrides
getDefaultInstanceForType()
public DashboardFilter getDefaultInstanceForType ()
getDefaultValueCase()
public DashboardFilter . DefaultValueCase getDefaultValueCase ()
getFilterType()
public DashboardFilter . FilterType getFilterType ()
The specified filter type
.google.monitoring.dashboard.v1.DashboardFilter.FilterType filter_type = 5;
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 ()
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.
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Overrides
hasStringValue()
public boolean hasStringValue ()
A variable-length string value.
string string_value = 4;
Returns
Type
Description
boolean
Whether the stringValue field is set.
hashCode()
Returns
Type
Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public DashboardFilter . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DashboardFilter . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type
Description
Object
Overrides
toBuilder()
public DashboardFilter . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-04-25 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-04-25 UTC."],[],[]]