Class ExecuteDashboardQueryRequest (0.31.0)

public final class ExecuteDashboardQueryRequest extends GeneratedMessage implements ExecuteDashboardQueryRequestOrBuilder

Request message to execute a dashboard query.

Protobuf type google.cloud.chronicle.v1.ExecuteDashboardQueryRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > ExecuteDashboardQueryRequest

Static Fields

CLEAR_CACHE_FIELD_NUMBER

public static final int CLEAR_CACHE_FIELD_NUMBER
Field Value
Type Description
int

FILTERS_FIELD_NUMBER

public static final int FILTERS_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
Type Description
int

USE_PREVIOUS_TIME_RANGE_FIELD_NUMBER

public static final int USE_PREVIOUS_TIME_RANGE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExecuteDashboardQueryRequest getDefaultInstance()
Returns
Type Description
ExecuteDashboardQueryRequest

getDescriptor()

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

newBuilder()

public static ExecuteDashboardQueryRequest.Builder newBuilder()
Returns
Type Description
ExecuteDashboardQueryRequest.Builder

newBuilder(ExecuteDashboardQueryRequest prototype)

public static ExecuteDashboardQueryRequest.Builder newBuilder(ExecuteDashboardQueryRequest prototype)
Parameter
Name Description
prototype ExecuteDashboardQueryRequest
Returns
Type Description
ExecuteDashboardQueryRequest.Builder

parseDelimitedFrom(InputStream input)

public static ExecuteDashboardQueryRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExecuteDashboardQueryRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteDashboardQueryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteDashboardQueryRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExecuteDashboardQueryRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExecuteDashboardQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExecuteDashboardQueryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteDashboardQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExecuteDashboardQueryRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExecuteDashboardQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExecuteDashboardQueryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteDashboardQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExecuteDashboardQueryRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExecuteDashboardQueryRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteDashboardQueryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteDashboardQueryRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExecuteDashboardQueryRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExecuteDashboardQueryRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteDashboardQueryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteDashboardQueryRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExecuteDashboardQueryRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExecuteDashboardQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExecuteDashboardQueryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteDashboardQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ExecuteDashboardQueryRequest> parser()
Returns
Type Description
Parser<ExecuteDashboardQueryRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

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

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.

getParserForType()

public Parser<ExecuteDashboardQueryRequest> getParserForType()
Returns
Type Description
Parser<ExecuteDashboardQueryRequest>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ExecuteDashboardQueryRequest.Builder newBuilderForType()
Returns
Type Description
ExecuteDashboardQueryRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ExecuteDashboardQueryRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExecuteDashboardQueryRequest.Builder
Overrides

toBuilder()

public ExecuteDashboardQueryRequest.Builder toBuilder()
Returns
Type Description
ExecuteDashboardQueryRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException