Class ExecuteDashboardQueryRequest.Builder (0.31.0)

public static final class ExecuteDashboardQueryRequest.Builder extends GeneratedMessage.Builder<ExecuteDashboardQueryRequest.Builder> implements ExecuteDashboardQueryRequestOrBuilder

Request message to execute a dashboard query.

Protobuf type google.cloud.chronicle.v1.ExecuteDashboardQueryRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllFilters(Iterable<? extends DashboardFilter> values)

public ExecuteDashboardQueryRequest.Builder addAllFilters(Iterable<? extends DashboardFilter> values)

Optional. Dashboard level filters other than query string.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.chronicle.v1.DashboardFilter>
Returns
Type Description
ExecuteDashboardQueryRequest.Builder

addFilters(DashboardFilter value)

public ExecuteDashboardQueryRequest.Builder addFilters(DashboardFilter value)

Optional. Dashboard level filters other than query string.

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

Parameter
Name Description
value DashboardFilter
Returns
Type Description
ExecuteDashboardQueryRequest.Builder

addFilters(DashboardFilter.Builder builderForValue)

public ExecuteDashboardQueryRequest.Builder addFilters(DashboardFilter.Builder builderForValue)

Optional. Dashboard level filters other than query string.

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

Parameter
Name Description
builderForValue DashboardFilter.Builder
Returns
Type Description
ExecuteDashboardQueryRequest.Builder

addFilters(int index, DashboardFilter value)

public ExecuteDashboardQueryRequest.Builder addFilters(int index, DashboardFilter value)

Optional. Dashboard level filters other than query string.

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

Parameters
Name Description
index int
value DashboardFilter
Returns
Type Description
ExecuteDashboardQueryRequest.Builder

addFilters(int index, DashboardFilter.Builder builderForValue)

public ExecuteDashboardQueryRequest.Builder addFilters(int index, DashboardFilter.Builder builderForValue)

Optional. Dashboard level filters other than query string.

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

Parameters
Name Description
index int
builderForValue DashboardFilter.Builder
Returns
Type Description
ExecuteDashboardQueryRequest.Builder

addFiltersBuilder()

public DashboardFilter.Builder addFiltersBuilder()

Optional. Dashboard level filters other than query string.

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

Returns
Type Description
DashboardFilter.Builder

addFiltersBuilder(int index)

public DashboardFilter.Builder addFiltersBuilder(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.Builder

build()

public ExecuteDashboardQueryRequest build()
Returns
Type Description
ExecuteDashboardQueryRequest

buildPartial()

public ExecuteDashboardQueryRequest buildPartial()
Returns
Type Description
ExecuteDashboardQueryRequest

clear()

public ExecuteDashboardQueryRequest.Builder clear()
Returns
Type Description
ExecuteDashboardQueryRequest.Builder
Overrides

clearClearCache()

public ExecuteDashboardQueryRequest.Builder clearClearCache()

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
ExecuteDashboardQueryRequest.Builder

This builder for chaining.

clearFilters()

public ExecuteDashboardQueryRequest.Builder clearFilters()

Optional. Dashboard level filters other than query string.

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

Returns
Type Description
ExecuteDashboardQueryRequest.Builder

clearParent()

public ExecuteDashboardQueryRequest.Builder clearParent()

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
ExecuteDashboardQueryRequest.Builder

This builder for chaining.

clearQuery()

public ExecuteDashboardQueryRequest.Builder clearQuery()

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
ExecuteDashboardQueryRequest.Builder

clearUsePreviousTimeRange()

public ExecuteDashboardQueryRequest.Builder clearUsePreviousTimeRange()

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
ExecuteDashboardQueryRequest.Builder

This builder for chaining.

getClearCache()

public 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.

getDefaultInstanceForType()

public ExecuteDashboardQueryRequest getDefaultInstanceForType()
Returns
Type Description
ExecuteDashboardQueryRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilters(int index)

public 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

getFiltersBuilder(int index)

public DashboardFilter.Builder getFiltersBuilder(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.Builder

getFiltersBuilderList()

public List<DashboardFilter.Builder> getFiltersBuilderList()

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

getFiltersCount()

public 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 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 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 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 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 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 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.

getQueryBuilder()

public DashboardQuery.Builder getQueryBuilder()

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.Builder

getQueryOrBuilder()

public 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ExecuteDashboardQueryRequest other)

public ExecuteDashboardQueryRequest.Builder mergeFrom(ExecuteDashboardQueryRequest other)
Parameter
Name Description
other ExecuteDashboardQueryRequest
Returns
Type Description
ExecuteDashboardQueryRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExecuteDashboardQueryRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteDashboardQueryRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ExecuteDashboardQueryRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ExecuteDashboardQueryRequest.Builder
Overrides

mergeQuery(DashboardQuery value)

public ExecuteDashboardQueryRequest.Builder mergeQuery(DashboardQuery value)

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];

Parameter
Name Description
value DashboardQuery
Returns
Type Description
ExecuteDashboardQueryRequest.Builder

removeFilters(int index)

public ExecuteDashboardQueryRequest.Builder removeFilters(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
ExecuteDashboardQueryRequest.Builder

setClearCache(boolean value)

public ExecuteDashboardQueryRequest.Builder setClearCache(boolean value)

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];

Parameter
Name Description
value boolean

The clearCache to set.

Returns
Type Description
ExecuteDashboardQueryRequest.Builder

This builder for chaining.

setFilters(int index, DashboardFilter value)

public ExecuteDashboardQueryRequest.Builder setFilters(int index, DashboardFilter value)

Optional. Dashboard level filters other than query string.

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

Parameters
Name Description
index int
value DashboardFilter
Returns
Type Description
ExecuteDashboardQueryRequest.Builder

setFilters(int index, DashboardFilter.Builder builderForValue)

public ExecuteDashboardQueryRequest.Builder setFilters(int index, DashboardFilter.Builder builderForValue)

Optional. Dashboard level filters other than query string.

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

Parameters
Name Description
index int
builderForValue DashboardFilter.Builder
Returns
Type Description
ExecuteDashboardQueryRequest.Builder

setParent(String value)

public ExecuteDashboardQueryRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ExecuteDashboardQueryRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ExecuteDashboardQueryRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ExecuteDashboardQueryRequest.Builder

This builder for chaining.

setQuery(DashboardQuery value)

public ExecuteDashboardQueryRequest.Builder setQuery(DashboardQuery value)

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];

Parameter
Name Description
value DashboardQuery
Returns
Type Description
ExecuteDashboardQueryRequest.Builder

setQuery(DashboardQuery.Builder builderForValue)

public ExecuteDashboardQueryRequest.Builder setQuery(DashboardQuery.Builder builderForValue)

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];

Parameter
Name Description
builderForValue DashboardQuery.Builder
Returns
Type Description
ExecuteDashboardQueryRequest.Builder

setUsePreviousTimeRange(boolean value)

public ExecuteDashboardQueryRequest.Builder setUsePreviousTimeRange(boolean value)

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];

Parameter
Name Description
value boolean

The usePreviousTimeRange to set.

Returns
Type Description
ExecuteDashboardQueryRequest.Builder

This builder for chaining.