Class DashboardFilter.Builder (0.31.0)

public static final class DashboardFilter.Builder extends GeneratedMessage.Builder<DashboardFilter.Builder> 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

Static Methods

getDescriptor()

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

Methods

addAllChartIds(Iterable<String> values)

public DashboardFilter.Builder addAllChartIds(Iterable<String> values)

Chart IDs the filter is applicable for.

repeated string chart_ids = 6;

Parameter
Name Description
values Iterable<String>

The chartIds to add.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

addAllFilterOperatorAndFieldValues(Iterable<? extends FilterOperatorAndValues> values)

public DashboardFilter.Builder addAllFilterOperatorAndFieldValues(Iterable<? extends FilterOperatorAndValues> values)

Operator and values. Can include multiple modifiers.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.chronicle.v1.FilterOperatorAndValues>
Returns
Type Description
DashboardFilter.Builder

addChartIds(String value)

public DashboardFilter.Builder addChartIds(String value)

Chart IDs the filter is applicable for.

repeated string chart_ids = 6;

Parameter
Name Description
value String

The chartIds to add.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

addChartIdsBytes(ByteString value)

public DashboardFilter.Builder addChartIdsBytes(ByteString value)

Chart IDs the filter is applicable for.

repeated string chart_ids = 6;

Parameter
Name Description
value ByteString

The bytes of the chartIds to add.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

addFilterOperatorAndFieldValues(FilterOperatorAndValues value)

public DashboardFilter.Builder addFilterOperatorAndFieldValues(FilterOperatorAndValues value)

Operator and values. Can include multiple modifiers.

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

Parameter
Name Description
value FilterOperatorAndValues
Returns
Type Description
DashboardFilter.Builder

addFilterOperatorAndFieldValues(FilterOperatorAndValues.Builder builderForValue)

public DashboardFilter.Builder addFilterOperatorAndFieldValues(FilterOperatorAndValues.Builder builderForValue)

Operator and values. Can include multiple modifiers.

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

Parameter
Name Description
builderForValue FilterOperatorAndValues.Builder
Returns
Type Description
DashboardFilter.Builder

addFilterOperatorAndFieldValues(int index, FilterOperatorAndValues value)

public DashboardFilter.Builder addFilterOperatorAndFieldValues(int index, FilterOperatorAndValues value)

Operator and values. Can include multiple modifiers.

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

Parameters
Name Description
index int
value FilterOperatorAndValues
Returns
Type Description
DashboardFilter.Builder

addFilterOperatorAndFieldValues(int index, FilterOperatorAndValues.Builder builderForValue)

public DashboardFilter.Builder addFilterOperatorAndFieldValues(int index, FilterOperatorAndValues.Builder builderForValue)

Operator and values. Can include multiple modifiers.

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

Parameters
Name Description
index int
builderForValue FilterOperatorAndValues.Builder
Returns
Type Description
DashboardFilter.Builder

addFilterOperatorAndFieldValuesBuilder()

public FilterOperatorAndValues.Builder addFilterOperatorAndFieldValuesBuilder()

Operator and values. Can include multiple modifiers.

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

Returns
Type Description
FilterOperatorAndValues.Builder

addFilterOperatorAndFieldValuesBuilder(int index)

public FilterOperatorAndValues.Builder addFilterOperatorAndFieldValuesBuilder(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.Builder

build()

public DashboardFilter build()
Returns
Type Description
DashboardFilter

buildPartial()

public DashboardFilter buildPartial()
Returns
Type Description
DashboardFilter

clear()

public DashboardFilter.Builder clear()
Returns
Type Description
DashboardFilter.Builder
Overrides

clearAdvancedFilterConfig()

public DashboardFilter.Builder clearAdvancedFilterConfig()

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

clearChartIds()

public DashboardFilter.Builder clearChartIds()

Chart IDs the filter is applicable for.

repeated string chart_ids = 6;

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

clearDataSource()

public DashboardFilter.Builder clearDataSource()

Datasource the filter is applicable for.

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

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

clearDisplayName()

public DashboardFilter.Builder clearDisplayName()

Display name of the filter.

string display_name = 5;

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

clearFieldPath()

public DashboardFilter.Builder clearFieldPath()

Filter field path.

string field_path = 3;

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

clearFilterOperatorAndFieldValues()

public DashboardFilter.Builder clearFilterOperatorAndFieldValues()

Operator and values. Can include multiple modifiers.

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

Returns
Type Description
DashboardFilter.Builder

clearId()

public DashboardFilter.Builder clearId()

ID of the filter.

string id = 1;

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

clearIsMandatory()

public DashboardFilter.Builder clearIsMandatory()

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

This builder for chaining.

clearIsStandardTimeRangeFilter()

public DashboardFilter.Builder clearIsStandardTimeRangeFilter()

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

This builder for chaining.

clearIsStandardTimeRangeFilterEnabled()

public DashboardFilter.Builder clearIsStandardTimeRangeFilterEnabled()

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

This builder for chaining.

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.

getAdvancedFilterConfigBuilder()

public AdvancedFilterConfig.Builder getAdvancedFilterConfigBuilder()

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.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

getFilterOperatorAndFieldValuesBuilder(int index)

public FilterOperatorAndValues.Builder getFilterOperatorAndFieldValuesBuilder(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.Builder

getFilterOperatorAndFieldValuesBuilderList()

public List<FilterOperatorAndValues.Builder> getFilterOperatorAndFieldValuesBuilderList()

Operator and values. Can include multiple modifiers.

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

Returns
Type Description
List<Builder>

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAdvancedFilterConfig(AdvancedFilterConfig value)

public DashboardFilter.Builder mergeAdvancedFilterConfig(AdvancedFilterConfig value)

Optional. Advanced filter configuration for the filter widget.

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

Parameter
Name Description
value AdvancedFilterConfig
Returns
Type Description
DashboardFilter.Builder

mergeFrom(DashboardFilter other)

public DashboardFilter.Builder mergeFrom(DashboardFilter other)
Parameter
Name Description
other DashboardFilter
Returns
Type Description
DashboardFilter.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DashboardFilter.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DashboardFilter.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DashboardFilter.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DashboardFilter.Builder
Overrides

removeFilterOperatorAndFieldValues(int index)

public DashboardFilter.Builder removeFilterOperatorAndFieldValues(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
DashboardFilter.Builder

setAdvancedFilterConfig(AdvancedFilterConfig value)

public DashboardFilter.Builder setAdvancedFilterConfig(AdvancedFilterConfig value)

Optional. Advanced filter configuration for the filter widget.

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

Parameter
Name Description
value AdvancedFilterConfig
Returns
Type Description
DashboardFilter.Builder

setAdvancedFilterConfig(AdvancedFilterConfig.Builder builderForValue)

public DashboardFilter.Builder setAdvancedFilterConfig(AdvancedFilterConfig.Builder builderForValue)

Optional. Advanced filter configuration for the filter widget.

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

Parameter
Name Description
builderForValue AdvancedFilterConfig.Builder
Returns
Type Description
DashboardFilter.Builder

setChartIds(int index, String value)

public DashboardFilter.Builder setChartIds(int index, String value)

Chart IDs the filter is applicable for.

repeated string chart_ids = 6;

Parameters
Name Description
index int

The index to set the value at.

value String

The chartIds to set.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

setDataSource(DataSource value)

public DashboardFilter.Builder setDataSource(DataSource value)

Datasource the filter is applicable for.

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

Parameter
Name Description
value DataSource

The dataSource to set.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

setDataSourceValue(int value)

public DashboardFilter.Builder setDataSourceValue(int value)

Datasource the filter is applicable for.

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

Parameter
Name Description
value int

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

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

setDisplayName(String value)

public DashboardFilter.Builder setDisplayName(String value)

Display name of the filter.

string display_name = 5;

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public DashboardFilter.Builder setDisplayNameBytes(ByteString value)

Display name of the filter.

string display_name = 5;

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

setFieldPath(String value)

public DashboardFilter.Builder setFieldPath(String value)

Filter field path.

string field_path = 3;

Parameter
Name Description
value String

The fieldPath to set.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

setFieldPathBytes(ByteString value)

public DashboardFilter.Builder setFieldPathBytes(ByteString value)

Filter field path.

string field_path = 3;

Parameter
Name Description
value ByteString

The bytes for fieldPath to set.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

setFilterOperatorAndFieldValues(int index, FilterOperatorAndValues value)

public DashboardFilter.Builder setFilterOperatorAndFieldValues(int index, FilterOperatorAndValues value)

Operator and values. Can include multiple modifiers.

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

Parameters
Name Description
index int
value FilterOperatorAndValues
Returns
Type Description
DashboardFilter.Builder

setFilterOperatorAndFieldValues(int index, FilterOperatorAndValues.Builder builderForValue)

public DashboardFilter.Builder setFilterOperatorAndFieldValues(int index, FilterOperatorAndValues.Builder builderForValue)

Operator and values. Can include multiple modifiers.

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

Parameters
Name Description
index int
builderForValue FilterOperatorAndValues.Builder
Returns
Type Description
DashboardFilter.Builder

setId(String value)

public DashboardFilter.Builder setId(String value)

ID of the filter.

string id = 1;

Parameter
Name Description
value String

The id to set.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

setIdBytes(ByteString value)

public DashboardFilter.Builder setIdBytes(ByteString value)

ID of the filter.

string id = 1;

Parameter
Name Description
value ByteString

The bytes for id to set.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

setIsMandatory(boolean value)

public DashboardFilter.Builder setIsMandatory(boolean value)

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];

Parameter
Name Description
value boolean

The isMandatory to set.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

setIsStandardTimeRangeFilter(boolean value)

public DashboardFilter.Builder setIsStandardTimeRangeFilter(boolean value)

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];

Parameter
Name Description
value boolean

The isStandardTimeRangeFilter to set.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.

setIsStandardTimeRangeFilterEnabled(boolean value)

public DashboardFilter.Builder setIsStandardTimeRangeFilterEnabled(boolean value)

Optional. Whether this standard time range filter is enabled.

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

Parameter
Name Description
value boolean

The isStandardTimeRangeFilterEnabled to set.

Returns
Type Description
DashboardFilter.Builder

This builder for chaining.