# Google Cloud Chronicle V1 Client - Class DashboardFilter (0.4.0)

0.4.0 (latest) 0.3.0 0.2.3 0.1.2 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 \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `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` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-chronicle/latest/V1.FilterOperatorAndValues>` Operator and values. Can include multiple modifiers. |
| `↳ 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` | `https://docs.cloud.google.com/php/docs/reference/cloud-chronicle/latest/V1.AdvancedFilterConfig` Optional. Advanced filter configuration for the filter widget. |

### getId

ID of the filter.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setId

ID of the filter.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDataSource

Datasource the filter is applicable for.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [DataSource](https://docs.cloud.google.com/php/docs/reference/cloud-chronicle/latest/V1.DataSource). |

### setDataSource

Datasource the filter is applicable for.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [DataSource](https://docs.cloud.google.com/php/docs/reference/cloud-chronicle/latest/V1.DataSource). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getFieldPath

Filter field path.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setFieldPath

Filter field path.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getFilterOperatorAndFieldValues

Operator and values. Can include multiple modifiers.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<https://docs.cloud.google.com/php/docs/reference/cloud-chronicle/latest/V1.FilterOperatorAndValues>` |   |

### setFilterOperatorAndFieldValues

Operator and values. Can include multiple modifiers.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-chronicle/latest/V1.FilterOperatorAndValues>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDisplayName

Display name of the filter.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setDisplayName

Display name of the filter.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getChartIds

Chart IDs the filter is applicable for.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<string>` |   |

### setChartIds

Chart IDs the filter is applicable for.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string[]` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getIsMandatory

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setIsMandatory

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getIsStandardTimeRangeFilterEnabled

Optional. Whether this standard time range filter is enabled.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### hasIsStandardTimeRangeFilterEnabled

### clearIsStandardTimeRangeFilterEnabled

### setIsStandardTimeRangeFilterEnabled

Optional. Whether this standard time range filter is enabled.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getAdvancedFilterConfig

Optional. Advanced filter configuration for the filter widget.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-chronicle/latest/V1.AdvancedFilterConfig|null` |   |

### hasAdvancedFilterConfig

### clearAdvancedFilterConfig

### setAdvancedFilterConfig

Optional. Advanced filter configuration for the filter widget.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-chronicle/latest/V1.AdvancedFilterConfig` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |