Reference documentation and code samples for the Google Cloud Chronicle V1 Client class ExecuteDashboardQueryRequest.
Request message to execute a dashboard query.
Generated from protobuf message google.cloud.chronicle.v1.ExecuteDashboardQueryRequest
Namespace
Google \ Cloud \ Chronicle \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent, under which to run this dashboardQuery. Format: projects/{project}/locations/{location}/instances/{instance} |
↳ query |
DashboardQuery
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. |
↳ filters |
array<DashboardFilter>
Optional. Dashboard level filters other than query string. |
↳ clear_cache |
bool
Optional. When true, the backend would read from the database, rather than fetching data directly from the cache. |
↳ use_previous_time_range |
bool
Optional. When true, the backend will execute the query against the previous time range of the query. |
getParent
Required. The parent, under which to run this dashboardQuery.
Format: projects/{project}/locations/{location}/instances/{instance}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent, under which to run this dashboardQuery.
Format: projects/{project}/locations/{location}/instances/{instance}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
DashboardQuery|null |
|
hasQuery
clearQuery
setQuery
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.
| Parameter | |
|---|---|
| Name | Description |
var |
DashboardQuery
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilters
Optional. Dashboard level filters other than query string.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<DashboardFilter> |
|
setFilters
Optional. Dashboard level filters other than query string.
| Parameter | |
|---|---|
| Name | Description |
var |
array<DashboardFilter>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClearCache
Optional. When true, the backend would read from the database, rather than fetching data directly from the cache.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setClearCache
Optional. When true, the backend would read from the database, rather than fetching data directly from the cache.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUsePreviousTimeRange
Optional. When true, the backend will execute the query against the previous time range of the query.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setUsePreviousTimeRange
Optional. When true, the backend will execute the query against the previous time range of the query.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent, under which to run this dashboardQuery. Format: projects/{project}/locations/{location}/instances/{instance} Please see DashboardQueryServiceClient::instanceName() for help formatting this field. |
query |
DashboardQuery
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. |
| Returns | |
|---|---|
| Type | Description |
ExecuteDashboardQueryRequest |
|