Reference documentation and code samples for the Google Cloud Chronicle V1 Client class DashboardFilter.
Dashboard level filter that can be used in native dashboards as well as inputs to execute query.
Generated from protobuf message google.cloud.chronicle.v1.DashboardFilter
Namespace
Google \ Cloud \ Chronicle \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ id
string
ID of the filter.
↳ data_source
int
Datasource the filter is applicable for.
↳ field_path
string
Filter field path.
↳ filter_operator_and_field_values
↳ display_name
string
Display name of the filter.
↳ chart_ids
string[]
Chart IDs the filter is applicable for.
↳ is_standard_time_range_filter
bool
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.
↳ is_mandatory
bool
Optional. Whether this filter is required to be populated by the dashboard consumer prior to the dashboard loading.
↳ is_standard_time_range_filter_enabled
bool
Optional. Whether this standard time range filter is enabled.
↳ advanced_filter_config
getId
ID of the filter.
string
setId
ID of the filter.
var
string
$this
getDataSource
Datasource the filter is applicable for.
setDataSource
Datasource the filter is applicable for.
$this
getFieldPath
Filter field path.
string
setFieldPath
Filter field path.
var
string
$this
getFilterOperatorAndFieldValues
Operator and values. Can include multiple modifiers.
setFilterOperatorAndFieldValues
Operator and values. Can include multiple modifiers.
$this
getDisplayName
Display name of the filter.
string
setDisplayName
Display name of the filter.
var
string
$this
getChartIds
Chart IDs the filter is applicable for.
setChartIds
Chart IDs the filter is applicable for.
var
string[]
$this
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
setIsStandardTimeRangeFilter
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.
var
bool
$this
getIsMandatory
Optional. Whether this filter is required to be populated by the dashboard consumer prior to the dashboard loading.
bool
setIsMandatory
Optional. Whether this filter is required to be populated by the dashboard consumer prior to the dashboard loading.
var
bool
$this
getIsStandardTimeRangeFilterEnabled
Optional. Whether this standard time range filter is enabled.
bool
hasIsStandardTimeRangeFilterEnabled
clearIsStandardTimeRangeFilterEnabled
setIsStandardTimeRangeFilterEnabled
Optional. Whether this standard time range filter is enabled.
var
bool
$this
getAdvancedFilterConfig
Optional. Advanced filter configuration for the filter widget.
hasAdvancedFilterConfig
clearAdvancedFilterConfig
setAdvancedFilterConfig
Optional. Advanced filter configuration for the filter widget.
$this
