Class DashboardFilter (0.31.0)

0.31.0 (latest) 0.29.0 0.26.0 0.25.0 0.23.0 0.21.0 0.20.0 0.19.0 0.18.0 0.16.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.8.0 0.6.0 0.5.0 0.2.0 0.1.0

public final class DashboardFilter extends GeneratedMessage implements DashboardFilterOrBuilder

Dashboard level filter that can be used in native dashboards as well as inputs to execute query.

Protobuf type google.cloud.chronicle.v1.DashboardFilter

Inheritance

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

Implements

DashboardFilterOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ADVANCED_FILTER_CONFIG_FIELD_NUMBER

public static final int ADVANCED_FILTER_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

CHART_IDS_FIELD_NUMBER

public static final int CHART_IDS_FIELD_NUMBER

Field Value
Type	Description
int

DATA_SOURCE_FIELD_NUMBER

public static final int DATA_SOURCE_FIELD_NUMBER

Field Value
Type	Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

Field Value
Type	Description
int

FIELD_PATH_FIELD_NUMBER

public static final int FIELD_PATH_FIELD_NUMBER

Field Value
Type	Description
int

FILTER_OPERATOR_AND_FIELD_VALUES_FIELD_NUMBER

public static final int FILTER_OPERATOR_AND_FIELD_VALUES_FIELD_NUMBER

Field Value
Type	Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

Field Value
Type	Description
int

IS_MANDATORY_FIELD_NUMBER

public static final int IS_MANDATORY_FIELD_NUMBER

Field Value
Type	Description
int

IS_STANDARD_TIME_RANGE_FILTER_ENABLED_FIELD_NUMBER

public static final int IS_STANDARD_TIME_RANGE_FILTER_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

IS_STANDARD_TIME_RANGE_FILTER_FIELD_NUMBER

public static final int IS_STANDARD_TIME_RANGE_FILTER_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

AbstractMessage.equals(Object other)

getAdvancedFilterConfig()

public AdvancedFilterConfig getAdvancedFilterConfig()

Optional. Advanced filter configuration for the filter widget.

.google.cloud.chronicle.v1.AdvancedFilterConfig advanced_filter_config = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AdvancedFilterConfig	The advancedFilterConfig.

getAdvancedFilterConfigOrBuilder()

public AdvancedFilterConfigOrBuilder getAdvancedFilterConfigOrBuilder()

Optional. Advanced filter configuration for the filter widget.

.google.cloud.chronicle.v1.AdvancedFilterConfig advanced_filter_config = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AdvancedFilterConfigOrBuilder

getChartIds(int index)

public String getChartIds(int index)

Chart IDs the filter is applicable for.

repeated string chart_ids = 6;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The chartIds at the given index.

getChartIdsBytes(int index)

public ByteString getChartIdsBytes(int index)

Chart IDs the filter is applicable for.

repeated string chart_ids = 6;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the chartIds at the given index.

getChartIdsCount()

public int getChartIdsCount()

Chart IDs the filter is applicable for.

repeated string chart_ids = 6;

Returns
Type	Description
int	The count of chartIds.

getChartIdsList()

public ProtocolStringList getChartIdsList()

Chart IDs the filter is applicable for.

repeated string chart_ids = 6;

Returns
Type	Description
ProtocolStringList	A list containing the chartIds.

getDataSource()

public DataSource getDataSource()

Datasource the filter is applicable for.

.google.cloud.chronicle.v1.DataSource data_source = 2;

Returns
Type	Description
DataSource	The dataSource.

getDataSourceValue()

public int getDataSourceValue()

Datasource the filter is applicable for.

.google.cloud.chronicle.v1.DataSource data_source = 2;

Returns
Type	Description
int	The enum numeric value on the wire for dataSource.

getDefaultInstanceForType()

public DashboardFilter getDefaultInstanceForType()

Returns
Type	Description
DashboardFilter

getDisplayName()

public String getDisplayName()

Display name of the filter.

string display_name = 5;

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Display name of the filter.

string display_name = 5;

Returns
Type	Description
ByteString	The bytes for displayName.

getFieldPath()

public String getFieldPath()

Filter field path.

string field_path = 3;

Returns
Type	Description
String	The fieldPath.

getFieldPathBytes()

public ByteString getFieldPathBytes()

Filter field path.

string field_path = 3;

Returns
Type	Description
ByteString	The bytes for fieldPath.

getFilterOperatorAndFieldValues(int index)

public FilterOperatorAndValues getFilterOperatorAndFieldValues(int index)

Operator and values. Can include multiple modifiers.

repeated .google.cloud.chronicle.v1.FilterOperatorAndValues filter_operator_and_field_values = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
FilterOperatorAndValues

getFilterOperatorAndFieldValuesCount()

public int getFilterOperatorAndFieldValuesCount()

Operator and values. Can include multiple modifiers.

repeated .google.cloud.chronicle.v1.FilterOperatorAndValues filter_operator_and_field_values = 4;

Returns
Type	Description
int

getFilterOperatorAndFieldValuesList()

public List<FilterOperatorAndValues> getFilterOperatorAndFieldValuesList()

Operator and values. Can include multiple modifiers.

repeated .google.cloud.chronicle.v1.FilterOperatorAndValues filter_operator_and_field_values = 4;

Returns
Type	Description
List<FilterOperatorAndValues>

getFilterOperatorAndFieldValuesOrBuilder(int index)

public FilterOperatorAndValuesOrBuilder getFilterOperatorAndFieldValuesOrBuilder(int index)

Operator and values. Can include multiple modifiers.

repeated .google.cloud.chronicle.v1.FilterOperatorAndValues filter_operator_and_field_values = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
FilterOperatorAndValuesOrBuilder

getFilterOperatorAndFieldValuesOrBuilderList()

public List<? extends FilterOperatorAndValuesOrBuilder> getFilterOperatorAndFieldValuesOrBuilderList()

Operator and values. Can include multiple modifiers.

repeated .google.cloud.chronicle.v1.FilterOperatorAndValues filter_operator_and_field_values = 4;

Returns
Type	Description
List<? extends com.google.cloud.chronicle.v1.FilterOperatorAndValuesOrBuilder>

getId()

public String getId()

ID of the filter.

string id = 1;

Returns
Type	Description
String	The id.

getIdBytes()

public ByteString getIdBytes()

ID of the filter.

string id = 1;

Returns
Type	Description
ByteString	The bytes for id.

getIsMandatory()

public boolean getIsMandatory()

Optional. Whether this filter is required to be populated by the dashboard consumer prior to the dashboard loading.

bool is_mandatory = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The isMandatory.

getIsStandardTimeRangeFilter()

public boolean getIsStandardTimeRangeFilter()

Optional. Whether the filter is a standard time range filter, meaning that it has to be used as the query time range, and not as a predicate in the query. A chart can have at most one standard time range filter applied.

bool is_standard_time_range_filter = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The isStandardTimeRangeFilter.

getIsStandardTimeRangeFilterEnabled()

public boolean getIsStandardTimeRangeFilterEnabled()

Optional. Whether this standard time range filter is enabled.

optional bool is_standard_time_range_filter_enabled = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The isStandardTimeRangeFilterEnabled.

getParserForType()

public Parser<DashboardFilter> getParserForType()

Returns
Type	Description
Parser<DashboardFilter>

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

hasAdvancedFilterConfig()

public boolean hasAdvancedFilterConfig()

Optional. Advanced filter configuration for the filter widget.

.google.cloud.chronicle.v1.AdvancedFilterConfig advanced_filter_config = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the advancedFilterConfig field is set.

hasIsStandardTimeRangeFilterEnabled()

public boolean hasIsStandardTimeRangeFilterEnabled()

Optional. Whether this standard time range filter is enabled.

optional bool is_standard_time_range_filter_enabled = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the isStandardTimeRangeFilterEnabled field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public DashboardFilter.Builder newBuilderForType()

Returns
Type	Description
DashboardFilter.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected DashboardFilter.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
DashboardFilter.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public DashboardFilter.Builder toBuilder()

Returns
Type	Description
DashboardFilter.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException