Interface DashboardFilterOrBuilder (0.31.0)

public interface DashboardFilterOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdvancedFilterConfig()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract int getChartIdsCount()

Chart IDs the filter is applicable for.

repeated string chart_ids = 6;

Returns
Type Description
int

The count of chartIds.

getChartIdsList()

public abstract List<String> getChartIdsList()

Chart IDs the filter is applicable for.

repeated string chart_ids = 6;

Returns
Type Description
List<String>

A list containing the chartIds.

getDataSource()

public abstract DataSource getDataSource()

Datasource the filter is applicable for.

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

Returns
Type Description
DataSource

The dataSource.

getDataSourceValue()

public abstract 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.

getDisplayName()

public abstract String getDisplayName()

Display name of the filter.

string display_name = 5;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Display name of the filter.

string display_name = 5;

Returns
Type Description
ByteString

The bytes for displayName.

getFieldPath()

public abstract String getFieldPath()

Filter field path.

string field_path = 3;

Returns
Type Description
String

The fieldPath.

getFieldPathBytes()

public abstract ByteString getFieldPathBytes()

Filter field path.

string field_path = 3;

Returns
Type Description
ByteString

The bytes for fieldPath.

getFilterOperatorAndFieldValues(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract String getId()

ID of the filter.

string id = 1;

Returns
Type Description
String

The id.

getIdBytes()

public abstract ByteString getIdBytes()

ID of the filter.

string id = 1;

Returns
Type Description
ByteString

The bytes for id.

getIsMandatory()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.