Class RunAggregationQueryRequest.Builder (2.23.0)

publicstaticfinalclass RunAggregationQueryRequest.BuilderextendsGeneratedMessageV3.Builder<RunAggregationQueryRequest.Builder>implementsRunAggregationQueryRequestOrBuilder

The request for Datastore.RunAggregationQuery.

Protobuf type google.datastore.v1.RunAggregationQueryRequest

Inherited Members

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

Static Methods

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicRunAggregationQueryRequest.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RunAggregationQueryRequest.Builder
Overrides

build()

publicRunAggregationQueryRequestbuild()
Returns
Type Description
RunAggregationQueryRequest

buildPartial()

publicRunAggregationQueryRequestbuildPartial()
Returns
Type Description
RunAggregationQueryRequest

clear()

publicRunAggregationQueryRequest.Builderclear()
Returns
Type Description
RunAggregationQueryRequest.Builder
Overrides

clearAggregationQuery()

publicRunAggregationQueryRequest.BuilderclearAggregationQuery()

The query to run.

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

Returns
Type Description
RunAggregationQueryRequest.Builder

clearDatabaseId()

publicRunAggregationQueryRequest.BuilderclearDatabaseId()

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

This builder for chaining.

clearExplainOptions()

publicRunAggregationQueryRequest.BuilderclearExplainOptions()

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

clearField(Descriptors.FieldDescriptor field)

publicRunAggregationQueryRequest.BuilderclearField(Descriptors.FieldDescriptorfield)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RunAggregationQueryRequest.Builder
Overrides

clearGqlQuery()

publicRunAggregationQueryRequest.BuilderclearGqlQuery()

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

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

Returns
Type Description
RunAggregationQueryRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

publicRunAggregationQueryRequest.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RunAggregationQueryRequest.Builder
Overrides

clearPartitionId()

publicRunAggregationQueryRequest.BuilderclearPartitionId()

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

clearProjectId()

publicRunAggregationQueryRequest.BuilderclearProjectId()

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

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

Returns
Type Description
RunAggregationQueryRequest.Builder

This builder for chaining.

clearQueryType()

publicRunAggregationQueryRequest.BuilderclearQueryType()
Returns
Type Description
RunAggregationQueryRequest.Builder

clearReadOptions()

publicRunAggregationQueryRequest.BuilderclearReadOptions()

The options for this query.

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

Returns
Type Description
RunAggregationQueryRequest.Builder

clone()

publicRunAggregationQueryRequest.Builderclone()
Returns
Type Description
RunAggregationQueryRequest.Builder
Overrides

getAggregationQuery()

publicAggregationQuerygetAggregationQuery()

The query to run.

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

Returns
Type Description
AggregationQuery

The aggregationQuery.

getAggregationQueryBuilder()

publicAggregationQuery.BuildergetAggregationQueryBuilder()

The query to run.

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

Returns
Type Description
AggregationQuery.Builder

getAggregationQueryOrBuilder()

publicAggregationQueryOrBuildergetAggregationQueryOrBuilder()

The query to run.

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

Returns
Type Description
AggregationQueryOrBuilder

getDatabaseId()

publicStringgetDatabaseId()

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()

publicByteStringgetDatabaseIdBytes()

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()

publicRunAggregationQueryRequestgetDefaultInstanceForType()
Returns
Type Description
RunAggregationQueryRequest

getDescriptorForType()

publicDescriptors.DescriptorgetDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getExplainOptions()

publicExplainOptionsgetExplainOptions()

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.

getExplainOptionsBuilder()

publicExplainOptions.BuildergetExplainOptionsBuilder()

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

getExplainOptionsOrBuilder()

publicExplainOptionsOrBuildergetExplainOptionsOrBuilder()

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()

publicGqlQuerygetGqlQuery()

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.

getGqlQueryBuilder()

publicGqlQuery.BuildergetGqlQueryBuilder()

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

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

Returns
Type Description
GqlQuery.Builder

getGqlQueryOrBuilder()

publicGqlQueryOrBuildergetGqlQueryOrBuilder()

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

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

Returns
Type Description
GqlQueryOrBuilder

getPartitionId()

publicPartitionIdgetPartitionId()

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.

getPartitionIdBuilder()

publicPartitionId.BuildergetPartitionIdBuilder()

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

getPartitionIdOrBuilder()

publicPartitionIdOrBuildergetPartitionIdOrBuilder()

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()

publicStringgetProjectId()

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()

publicByteStringgetProjectIdBytes()

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()

publicRunAggregationQueryRequest.QueryTypeCasegetQueryTypeCase()
Returns
Type Description
RunAggregationQueryRequest.QueryTypeCase

getReadOptions()

publicReadOptionsgetReadOptions()

The options for this query.

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

Returns
Type Description
ReadOptions

The readOptions.

getReadOptionsBuilder()

publicReadOptions.BuildergetReadOptionsBuilder()

The options for this query.

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

Returns
Type Description
ReadOptions.Builder

getReadOptionsOrBuilder()

publicReadOptionsOrBuildergetReadOptionsOrBuilder()

The options for this query.

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

Returns
Type Description
ReadOptionsOrBuilder

hasAggregationQuery()

publicbooleanhasAggregationQuery()

The query to run.

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

Returns
Type Description
boolean

Whether the aggregationQuery field is set.

hasExplainOptions()

publicbooleanhasExplainOptions()

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()

publicbooleanhasGqlQuery()

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()

publicbooleanhasPartitionId()

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()

publicbooleanhasReadOptions()

The options for this query.

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

Returns
Type Description
boolean

Whether the readOptions field is set.

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

mergeAggregationQuery(AggregationQuery value)

publicRunAggregationQueryRequest.BuildermergeAggregationQuery(AggregationQueryvalue)

The query to run.

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

Parameter
Name Description
value AggregationQuery
Returns
Type Description
RunAggregationQueryRequest.Builder

mergeExplainOptions(ExplainOptions value)

publicRunAggregationQueryRequest.BuildermergeExplainOptions(ExplainOptionsvalue)

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

Parameter
Name Description
value ExplainOptions
Returns
Type Description
RunAggregationQueryRequest.Builder

mergeFrom(RunAggregationQueryRequest other)

publicRunAggregationQueryRequest.BuildermergeFrom(RunAggregationQueryRequestother)
Parameter
Name Description
other RunAggregationQueryRequest
Returns
Type Description
RunAggregationQueryRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicRunAggregationQueryRequest.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunAggregationQueryRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

publicRunAggregationQueryRequest.BuildermergeFrom(Messageother)
Parameter
Name Description
other Message
Returns
Type Description
RunAggregationQueryRequest.Builder
Overrides

mergeGqlQuery(GqlQuery value)

publicRunAggregationQueryRequest.BuildermergeGqlQuery(GqlQueryvalue)

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

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

Parameter
Name Description
value GqlQuery
Returns
Type Description
RunAggregationQueryRequest.Builder

mergePartitionId(PartitionId value)

publicRunAggregationQueryRequest.BuildermergePartitionId(PartitionIdvalue)

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;

Parameter
Name Description
value PartitionId
Returns
Type Description
RunAggregationQueryRequest.Builder

mergeReadOptions(ReadOptions value)

publicRunAggregationQueryRequest.BuildermergeReadOptions(ReadOptionsvalue)

The options for this query.

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

Parameter
Name Description
value ReadOptions
Returns
Type Description
RunAggregationQueryRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

publicfinalRunAggregationQueryRequest.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RunAggregationQueryRequest.Builder
Overrides

setAggregationQuery(AggregationQuery value)

publicRunAggregationQueryRequest.BuildersetAggregationQuery(AggregationQueryvalue)

The query to run.

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

Parameter
Name Description
value AggregationQuery
Returns
Type Description
RunAggregationQueryRequest.Builder

setAggregationQuery(AggregationQuery.Builder builderForValue)

publicRunAggregationQueryRequest.BuildersetAggregationQuery(AggregationQuery.BuilderbuilderForValue)

The query to run.

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

Parameter
Name Description
builderForValue AggregationQuery.Builder
Returns
Type Description
RunAggregationQueryRequest.Builder

setDatabaseId(String value)

publicRunAggregationQueryRequest.BuildersetDatabaseId(Stringvalue)

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;

Parameter
Name Description
value String

The databaseId to set.

Returns
Type Description
RunAggregationQueryRequest.Builder

This builder for chaining.

setDatabaseIdBytes(ByteString value)

publicRunAggregationQueryRequest.BuildersetDatabaseIdBytes(ByteStringvalue)

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;

Parameter
Name Description
value ByteString

The bytes for databaseId to set.

Returns
Type Description
RunAggregationQueryRequest.Builder

This builder for chaining.

setExplainOptions(ExplainOptions value)

publicRunAggregationQueryRequest.BuildersetExplainOptions(ExplainOptionsvalue)

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

Parameter
Name Description
value ExplainOptions
Returns
Type Description
RunAggregationQueryRequest.Builder

setExplainOptions(ExplainOptions.Builder builderForValue)

publicRunAggregationQueryRequest.BuildersetExplainOptions(ExplainOptions.BuilderbuilderForValue)

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

Parameter
Name Description
builderForValue ExplainOptions.Builder
Returns
Type Description
RunAggregationQueryRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

publicRunAggregationQueryRequest.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RunAggregationQueryRequest.Builder
Overrides

setGqlQuery(GqlQuery value)

publicRunAggregationQueryRequest.BuildersetGqlQuery(GqlQueryvalue)

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

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

Parameter
Name Description
value GqlQuery
Returns
Type Description
RunAggregationQueryRequest.Builder

setGqlQuery(GqlQuery.Builder builderForValue)

publicRunAggregationQueryRequest.BuildersetGqlQuery(GqlQuery.BuilderbuilderForValue)

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

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

Parameter
Name Description
builderForValue GqlQuery.Builder
Returns
Type Description
RunAggregationQueryRequest.Builder

setPartitionId(PartitionId value)

publicRunAggregationQueryRequest.BuildersetPartitionId(PartitionIdvalue)

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;

Parameter
Name Description
value PartitionId
Returns
Type Description
RunAggregationQueryRequest.Builder

setPartitionId(PartitionId.Builder builderForValue)

publicRunAggregationQueryRequest.BuildersetPartitionId(PartitionId.BuilderbuilderForValue)

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;

Parameter
Name Description
builderForValue PartitionId.Builder
Returns
Type Description
RunAggregationQueryRequest.Builder

setProjectId(String value)

publicRunAggregationQueryRequest.BuildersetProjectId(Stringvalue)

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

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

Parameter
Name Description
value String

The projectId to set.

Returns
Type Description
RunAggregationQueryRequest.Builder

This builder for chaining.

setProjectIdBytes(ByteString value)

publicRunAggregationQueryRequest.BuildersetProjectIdBytes(ByteStringvalue)

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

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

Parameter
Name Description
value ByteString

The bytes for projectId to set.

Returns
Type Description
RunAggregationQueryRequest.Builder

This builder for chaining.

setReadOptions(ReadOptions value)

publicRunAggregationQueryRequest.BuildersetReadOptions(ReadOptionsvalue)

The options for this query.

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

Parameter
Name Description
value ReadOptions
Returns
Type Description
RunAggregationQueryRequest.Builder

setReadOptions(ReadOptions.Builder builderForValue)

publicRunAggregationQueryRequest.BuildersetReadOptions(ReadOptions.BuilderbuilderForValue)

The options for this query.

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

Parameter
Name Description
builderForValue ReadOptions.Builder
Returns
Type Description
RunAggregationQueryRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

publicRunAggregationQueryRequest.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RunAggregationQueryRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

publicfinalRunAggregationQueryRequest.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RunAggregationQueryRequest.Builder
Overrides

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.