Class RunAggregationQueryRequest (2.21.2) 

public final class RunAggregationQueryRequest extends GeneratedMessageV3 implements RunAggregationQueryRequestOrBuilder

The request for Datastore.RunAggregationQuery.

Protobuf type google.datastore.v1.RunAggregationQueryRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > RunAggregationQueryRequest

Static Fields

AGGREGATION_QUERY_FIELD_NUMBER

public static final int AGGREGATION_QUERY_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_ID_FIELD_NUMBER

public static final int DATABASE_ID_FIELD_NUMBER
Field Value
Type Description
int

EXPLAIN_OPTIONS_FIELD_NUMBER

public static final int EXPLAIN_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

GQL_QUERY_FIELD_NUMBER

public static final int GQL_QUERY_FIELD_NUMBER
Field Value
Type Description
int

PARTITION_ID_FIELD_NUMBER

public static final int PARTITION_ID_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

READ_OPTIONS_FIELD_NUMBER

public static final int READ_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RunAggregationQueryRequest getDefaultInstance()
Returns
Type Description
RunAggregationQueryRequest

getDescriptor()

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

newBuilder()

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

newBuilder(RunAggregationQueryRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAggregationQuery()

public AggregationQuery getAggregationQuery()

The query to run.

.google.datastore.v1.AggregationQuery aggregation_query = 3;

Returns
Type Description
AggregationQuery

The aggregationQuery.

getAggregationQueryOrBuilder()

public AggregationQueryOrBuilder getAggregationQueryOrBuilder()

The query to run.

.google.datastore.v1.AggregationQuery aggregation_query = 3;

Returns
Type Description
AggregationQueryOrBuilder

getDatabaseId()

public String getDatabaseId()

The ID of the database against which to make the request.

'(default)' is not allowed; please use empty string '' to refer the default database.

string database_id = 9;

Returns
Type Description
String

The databaseId.

getDatabaseIdBytes()

public ByteString getDatabaseIdBytes()

The ID of the database against which to make the request.

'(default)' is not allowed; please use empty string '' to refer the default database.

string database_id = 9;

Returns
Type Description
ByteString

The bytes for databaseId.

getDefaultInstanceForType()

public RunAggregationQueryRequest getDefaultInstanceForType()
Returns
Type Description
RunAggregationQueryRequest

getExplainOptions()

public ExplainOptions getExplainOptions()

Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.

.google.datastore.v1.ExplainOptions explain_options = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExplainOptions

The explainOptions.

getExplainOptionsOrBuilder()

public ExplainOptionsOrBuilder getExplainOptionsOrBuilder()

Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.

.google.datastore.v1.ExplainOptions explain_options = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExplainOptionsOrBuilder

getGqlQuery()

public GqlQuery getGqlQuery()

The GQL query to run. This query must be an aggregation query.

.google.datastore.v1.GqlQuery gql_query = 7;

Returns
Type Description
GqlQuery

The gqlQuery.

getGqlQueryOrBuilder()

public GqlQueryOrBuilder getGqlQueryOrBuilder()

The GQL query to run. This query must be an aggregation query.

.google.datastore.v1.GqlQuery gql_query = 7;

Returns
Type Description
GqlQueryOrBuilder

getParserForType()

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

getPartitionId()

public PartitionId getPartitionId()

Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.

.google.datastore.v1.PartitionId partition_id = 2;

Returns
Type Description
PartitionId

The partitionId.

getPartitionIdOrBuilder()

public PartitionIdOrBuilder getPartitionIdOrBuilder()

Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.

.google.datastore.v1.PartitionId partition_id = 2;

Returns
Type Description
PartitionIdOrBuilder

getProjectId()

public String getProjectId()

Required. The ID of the project against which to make the request.

string project_id = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

Required. The ID of the project against which to make the request.

string project_id = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for projectId.

getQueryTypeCase()

public RunAggregationQueryRequest.QueryTypeCase getQueryTypeCase()
Returns
Type Description
RunAggregationQueryRequest.QueryTypeCase

getReadOptions()

public ReadOptions getReadOptions()

The options for this query.

.google.datastore.v1.ReadOptions read_options = 1;

Returns
Type Description
ReadOptions

The readOptions.

getReadOptionsOrBuilder()

public ReadOptionsOrBuilder getReadOptionsOrBuilder()

The options for this query.

.google.datastore.v1.ReadOptions read_options = 1;

Returns
Type Description
ReadOptionsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasAggregationQuery()

public boolean hasAggregationQuery()

The query to run.

.google.datastore.v1.AggregationQuery aggregation_query = 3;

Returns
Type Description
boolean

Whether the aggregationQuery field is set.

hasExplainOptions()

public boolean hasExplainOptions()

Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.

.google.datastore.v1.ExplainOptions explain_options = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the explainOptions field is set.

hasGqlQuery()

public boolean hasGqlQuery()

The GQL query to run. This query must be an aggregation query.

.google.datastore.v1.GqlQuery gql_query = 7;

Returns
Type Description
boolean

Whether the gqlQuery field is set.

hasPartitionId()

public boolean hasPartitionId()

Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.

.google.datastore.v1.PartitionId partition_id = 2;

Returns
Type Description
boolean

Whether the partitionId field is set.

hasReadOptions()

public boolean hasReadOptions()

The options for this query.

.google.datastore.v1.ReadOptions read_options = 1;

Returns
Type Description
boolean

Whether the readOptions field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RunAggregationQueryRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RunAggregationQueryRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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