# Interface ExecuteDashboardQueryRequestOrBuilder (0.31.0)

0.31.0 (latest) 0.29.0 0.26.0 0.25.0 0.23.0 0.21.0 0.20.0 0.19.0 0.18.0 0.16.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.8.0 0.6.0 0.5.0 0.2.0 0.1.0

    public interface ExecuteDashboardQueryRequestOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### getClearCache()

    public abstract boolean getClearCache()

Optional. When true, the backend would read from the database, rather than
fetching data directly from the cache.

`bool clear_cache = 4 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The clearCache. |

### getFilters(int index)

    public abstract DashboardFilter getFilters(int index)

Optional. Dashboard level filters other than query string.

`
repeated .google.cloud.chronicle.v1.DashboardFilter filters = 3 [(.google.api.field_behavior) = OPTIONAL];
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-chronicle/latest/com.google.cloud.chronicle.v1.DashboardFilter` |   |

### getFiltersCount()

    public abstract int getFiltersCount()

Optional. Dashboard level filters other than query string.

`
repeated .google.cloud.chronicle.v1.DashboardFilter filters = 3 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### getFiltersList()

    public abstract List<DashboardFilter> getFiltersList()

Optional. Dashboard level filters other than query string.

`
repeated .google.cloud.chronicle.v1.DashboardFilter filters = 3 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-chronicle/latest/com.google.cloud.chronicle.v1.DashboardFilter>` |   |

### getFiltersOrBuilder(int index)

    public abstract DashboardFilterOrBuilder getFiltersOrBuilder(int index)

Optional. Dashboard level filters other than query string.

`
repeated .google.cloud.chronicle.v1.DashboardFilter filters = 3 [(.google.api.field_behavior) = OPTIONAL];
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-chronicle/latest/com.google.cloud.chronicle.v1.DashboardFilterOrBuilder` |   |

### getFiltersOrBuilderList()

    public abstract List<? extends DashboardFilterOrBuilder> getFiltersOrBuilderList()

Optional. Dashboard level filters other than query string.

`
repeated .google.cloud.chronicle.v1.DashboardFilter filters = 3 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<? extends com.google.cloud.chronicle.v1.DashboardFilterOrBuilder>` |   |

### getParent()

    public abstract String getParent()

Required. The parent, under which to run this dashboardQuery.
Format: projects/{project}/locations/{location}/instances/{instance}

`
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The parent. |

### getParentBytes()

    public abstract ByteString getParentBytes()

Required. The parent, under which to run this dashboardQuery.
Format: projects/{project}/locations/{location}/instances/{instance}

`
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for parent. |

### getQuery()

    public abstract DashboardQuery getQuery()

Required. The query to execute and get results back for.
QueryID or 'query', 'input.time_window' fields will be used. Use
'native_dashboard' and 'dashboard_chart' fields if it is an in-dashboard
query.

`
.google.cloud.chronicle.v1.DashboardQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-chronicle/latest/com.google.cloud.chronicle.v1.DashboardQuery` | The query. |

### getQueryOrBuilder()

    public abstract DashboardQueryOrBuilder getQueryOrBuilder()

Required. The query to execute and get results back for.
QueryID or 'query', 'input.time_window' fields will be used. Use
'native_dashboard' and 'dashboard_chart' fields if it is an in-dashboard
query.

`
.google.cloud.chronicle.v1.DashboardQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-chronicle/latest/com.google.cloud.chronicle.v1.DashboardQueryOrBuilder` |   |

### getUsePreviousTimeRange()

    public abstract boolean getUsePreviousTimeRange()

Optional. When true, the backend will execute the query against the
previous time range of the query.

`bool use_previous_time_range = 5 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The usePreviousTimeRange. |

### hasQuery()

    public abstract boolean hasQuery()

Required. The query to execute and get results back for.
QueryID or 'query', 'input.time_window' fields will be used. Use
'native_dashboard' and 'dashboard_chart' fields if it is an in-dashboard
query.

`
.google.cloud.chronicle.v1.DashboardQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the query field is set. |