0.9.0 (latest) 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.1 0.2.0 0.1.0 Reference documentation and code samples for the Chronicle V1 API class Google::Cloud::Chronicle::V1::DashboardFilter.

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

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #advanced_filter_config

    def advanced_filter_config() -> ::Google::Cloud::Chronicle::V1::AdvancedFilterConfig

**Returns**

- ([::Google::Cloud::Chronicle::V1::AdvancedFilterConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-AdvancedFilterConfig)) --- Optional. Advanced filter configuration for the filter widget.

### #advanced_filter_config=

    def advanced_filter_config=(value) -> ::Google::Cloud::Chronicle::V1::AdvancedFilterConfig

**Parameter**

- **value** ([::Google::Cloud::Chronicle::V1::AdvancedFilterConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-AdvancedFilterConfig)) --- Optional. Advanced filter configuration for the filter widget.
**Returns**

- ([::Google::Cloud::Chronicle::V1::AdvancedFilterConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-AdvancedFilterConfig)) --- Optional. Advanced filter configuration for the filter widget.

### #chart_ids

    def chart_ids() -> ::Array<::String>

**Returns**

- (::Array\<::String\>) --- Chart IDs the filter is applicable for.

### #chart_ids=

    def chart_ids=(value) -> ::Array<::String>

**Parameter**

- **value** (::Array\<::String\>) --- Chart IDs the filter is applicable for.
**Returns**

- (::Array\<::String\>) --- Chart IDs the filter is applicable for.

### #data_source

    def data_source() -> ::Google::Cloud::Chronicle::V1::DataSource

**Returns**

- ([::Google::Cloud::Chronicle::V1::DataSource](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-DataSource)) --- Datasource the filter is applicable for.

### #data_source=

    def data_source=(value) -> ::Google::Cloud::Chronicle::V1::DataSource

**Parameter**

- **value** ([::Google::Cloud::Chronicle::V1::DataSource](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-DataSource)) --- Datasource the filter is applicable for.
**Returns**

- ([::Google::Cloud::Chronicle::V1::DataSource](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-DataSource)) --- Datasource the filter is applicable for.

### #display_name

    def display_name() -> ::String

**Returns**

- (::String) --- Display name of the filter.

### #display_name=

    def display_name=(value) -> ::String

**Parameter**

- **value** (::String) --- Display name of the filter.
**Returns**

- (::String) --- Display name of the filter.

### #field_path

    def field_path() -> ::String

**Returns**

- (::String) --- Filter field path.

### #field_path=

    def field_path=(value) -> ::String

**Parameter**

- **value** (::String) --- Filter field path.
**Returns**

- (::String) --- Filter field path.

### #filter_operator_and_field_values

    def filter_operator_and_field_values() -> ::Array<::Google::Cloud::Chronicle::V1::FilterOperatorAndValues>

**Returns**

- (::Array\<[::Google::Cloud::Chronicle::V1::FilterOperatorAndValues](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-FilterOperatorAndValues)\>) --- Operator and values. Can include multiple modifiers.

### #filter_operator_and_field_values=

    def filter_operator_and_field_values=(value) -> ::Array<::Google::Cloud::Chronicle::V1::FilterOperatorAndValues>

**Parameter**

- **value** (::Array\<[::Google::Cloud::Chronicle::V1::FilterOperatorAndValues](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-FilterOperatorAndValues)\>) --- Operator and values. Can include multiple modifiers.
**Returns**

- (::Array\<[::Google::Cloud::Chronicle::V1::FilterOperatorAndValues](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-FilterOperatorAndValues)\>) --- Operator and values. Can include multiple modifiers.

### #id

    def id() -> ::String

**Returns**

- (::String) --- ID of the filter.

### #id=

    def id=(value) -> ::String

**Parameter**

- **value** (::String) --- ID of the filter.
**Returns**

- (::String) --- ID of the filter.

### #is_mandatory

    def is_mandatory() -> ::Boolean

**Returns**

- (::Boolean) --- Optional. Whether this filter is required to be populated by the dashboard consumer prior to the dashboard loading.

### #is_mandatory=

    def is_mandatory=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- Optional. Whether this filter is required to be populated by the dashboard consumer prior to the dashboard loading.
**Returns**

- (::Boolean) --- Optional. Whether this filter is required to be populated by the dashboard consumer prior to the dashboard loading.

### #is_standard_time_range_filter

    def is_standard_time_range_filter() -> ::Boolean

**Returns**

- (::Boolean) --- 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_standard_time_range_filter=

    def is_standard_time_range_filter=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- 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.
**Returns**

- (::Boolean) --- 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_standard_time_range_filter_enabled

    def is_standard_time_range_filter_enabled() -> ::Boolean

**Returns**

- (::Boolean) --- Optional. Whether this standard time range filter is enabled.

### #is_standard_time_range_filter_enabled=

    def is_standard_time_range_filter_enabled=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- Optional. Whether this standard time range filter is enabled.
**Returns**

- (::Boolean) --- Optional. Whether this standard time range filter is enabled.