Interface ExecuteDashboardQueryRequestOrBuilder (0.31.0) 

public interface ExecuteDashboardQueryRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

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
boolean

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 int
Returns
Type Description
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
int

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
List<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 int
Returns
Type Description
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
List<? 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
String

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
ByteString

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
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
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
boolean

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
boolean

Whether the query field is set.