Class RunAggregationQueryResponse.Builder (2.20.0)

public static final class RunAggregationQueryResponse.Builder extends GeneratedMessageV3.Builder<RunAggregationQueryResponse.Builder> implements RunAggregationQueryResponseOrBuilder

The response for Datastore.RunAggregationQuery.

Protobuf type google.datastore.v1.RunAggregationQueryResponse

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RunAggregationQueryResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RunAggregationQueryResponse.Builder
Overrides

build()

public RunAggregationQueryResponse build()
Returns
Type Description
RunAggregationQueryResponse

buildPartial()

public RunAggregationQueryResponse buildPartial()
Returns
Type Description
RunAggregationQueryResponse

clear()

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

clearBatch()

public RunAggregationQueryResponse.Builder clearBatch()

A batch of aggregation results. Always present.

.google.datastore.v1.AggregationResultBatch batch = 1;

Returns
Type Description
RunAggregationQueryResponse.Builder

clearExplainMetrics()

public RunAggregationQueryResponse.Builder clearExplainMetrics()

Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.

.google.datastore.v1.ExplainMetrics explain_metrics = 9;

Returns
Type Description
RunAggregationQueryResponse.Builder

clearField(Descriptors.FieldDescriptor field)

public RunAggregationQueryResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RunAggregationQueryResponse.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public RunAggregationQueryResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RunAggregationQueryResponse.Builder
Overrides

clearQuery()

public RunAggregationQueryResponse.Builder clearQuery()

The parsed form of the GqlQuery from the request, if it was set.

.google.datastore.v1.AggregationQuery query = 2;

Returns
Type Description
RunAggregationQueryResponse.Builder

clearTransaction()

public RunAggregationQueryResponse.Builder clearTransaction()

The identifier of the transaction that was started as part of this RunAggregationQuery request.

Set only when ReadOptions.new_transaction was set in RunAggregationQueryRequest.read_options.

bytes transaction = 5;

Returns
Type Description
RunAggregationQueryResponse.Builder

This builder for chaining.

clone()

public RunAggregationQueryResponse.Builder clone()
Returns
Type Description
RunAggregationQueryResponse.Builder
Overrides

getBatch()

public AggregationResultBatch getBatch()

A batch of aggregation results. Always present.

.google.datastore.v1.AggregationResultBatch batch = 1;

Returns
Type Description
AggregationResultBatch

The batch.

getBatchBuilder()

public AggregationResultBatch.Builder getBatchBuilder()

A batch of aggregation results. Always present.

.google.datastore.v1.AggregationResultBatch batch = 1;

Returns
Type Description
AggregationResultBatch.Builder

getBatchOrBuilder()

public AggregationResultBatchOrBuilder getBatchOrBuilder()

A batch of aggregation results. Always present.

.google.datastore.v1.AggregationResultBatch batch = 1;

Returns
Type Description
AggregationResultBatchOrBuilder

getDefaultInstanceForType()

public RunAggregationQueryResponse getDefaultInstanceForType()
Returns
Type Description
RunAggregationQueryResponse

getDescriptorForType()

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

getExplainMetrics()

public ExplainMetrics getExplainMetrics()

Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.

.google.datastore.v1.ExplainMetrics explain_metrics = 9;

Returns
Type Description
ExplainMetrics

The explainMetrics.

getExplainMetricsBuilder()

public ExplainMetrics.Builder getExplainMetricsBuilder()

Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.

.google.datastore.v1.ExplainMetrics explain_metrics = 9;

Returns
Type Description
ExplainMetrics.Builder

getExplainMetricsOrBuilder()

public ExplainMetricsOrBuilder getExplainMetricsOrBuilder()

Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.

.google.datastore.v1.ExplainMetrics explain_metrics = 9;

Returns
Type Description
ExplainMetricsOrBuilder

getQuery()

public AggregationQuery getQuery()

The parsed form of the GqlQuery from the request, if it was set.

.google.datastore.v1.AggregationQuery query = 2;

Returns
Type Description
AggregationQuery

The query.

getQueryBuilder()

public AggregationQuery.Builder getQueryBuilder()

The parsed form of the GqlQuery from the request, if it was set.

.google.datastore.v1.AggregationQuery query = 2;

Returns
Type Description
AggregationQuery.Builder

getQueryOrBuilder()

public AggregationQueryOrBuilder getQueryOrBuilder()

The parsed form of the GqlQuery from the request, if it was set.

.google.datastore.v1.AggregationQuery query = 2;

Returns
Type Description
AggregationQueryOrBuilder

getTransaction()

public ByteString getTransaction()

The identifier of the transaction that was started as part of this RunAggregationQuery request.

Set only when ReadOptions.new_transaction was set in RunAggregationQueryRequest.read_options.

bytes transaction = 5;

Returns
Type Description
ByteString

The transaction.

hasBatch()

public boolean hasBatch()

A batch of aggregation results. Always present.

.google.datastore.v1.AggregationResultBatch batch = 1;

Returns
Type Description
boolean

Whether the batch field is set.

hasExplainMetrics()

public boolean hasExplainMetrics()

Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.

.google.datastore.v1.ExplainMetrics explain_metrics = 9;

Returns
Type Description
boolean

Whether the explainMetrics field is set.

hasQuery()

public boolean hasQuery()

The parsed form of the GqlQuery from the request, if it was set.

.google.datastore.v1.AggregationQuery query = 2;

Returns
Type Description
boolean

Whether the query field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBatch(AggregationResultBatch value)

public RunAggregationQueryResponse.Builder mergeBatch(AggregationResultBatch value)

A batch of aggregation results. Always present.

.google.datastore.v1.AggregationResultBatch batch = 1;

Parameter
Name Description
value AggregationResultBatch
Returns
Type Description
RunAggregationQueryResponse.Builder

mergeExplainMetrics(ExplainMetrics value)

public RunAggregationQueryResponse.Builder mergeExplainMetrics(ExplainMetrics value)

Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.

.google.datastore.v1.ExplainMetrics explain_metrics = 9;

Parameter
Name Description
value ExplainMetrics
Returns
Type Description
RunAggregationQueryResponse.Builder

mergeFrom(RunAggregationQueryResponse other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeQuery(AggregationQuery value)

public RunAggregationQueryResponse.Builder mergeQuery(AggregationQuery value)

The parsed form of the GqlQuery from the request, if it was set.

.google.datastore.v1.AggregationQuery query = 2;

Parameter
Name Description
value AggregationQuery
Returns
Type Description
RunAggregationQueryResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RunAggregationQueryResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RunAggregationQueryResponse.Builder
Overrides

setBatch(AggregationResultBatch value)

public RunAggregationQueryResponse.Builder setBatch(AggregationResultBatch value)

A batch of aggregation results. Always present.

.google.datastore.v1.AggregationResultBatch batch = 1;

Parameter
Name Description
value AggregationResultBatch
Returns
Type Description
RunAggregationQueryResponse.Builder

setBatch(AggregationResultBatch.Builder builderForValue)

public RunAggregationQueryResponse.Builder setBatch(AggregationResultBatch.Builder builderForValue)

A batch of aggregation results. Always present.

.google.datastore.v1.AggregationResultBatch batch = 1;

Parameter
Name Description
builderForValue AggregationResultBatch.Builder
Returns
Type Description
RunAggregationQueryResponse.Builder

setExplainMetrics(ExplainMetrics value)

public RunAggregationQueryResponse.Builder setExplainMetrics(ExplainMetrics value)

Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.

.google.datastore.v1.ExplainMetrics explain_metrics = 9;

Parameter
Name Description
value ExplainMetrics
Returns
Type Description
RunAggregationQueryResponse.Builder

setExplainMetrics(ExplainMetrics.Builder builderForValue)

public RunAggregationQueryResponse.Builder setExplainMetrics(ExplainMetrics.Builder builderForValue)

Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.

.google.datastore.v1.ExplainMetrics explain_metrics = 9;

Parameter
Name Description
builderForValue ExplainMetrics.Builder
Returns
Type Description
RunAggregationQueryResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RunAggregationQueryResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RunAggregationQueryResponse.Builder
Overrides

setQuery(AggregationQuery value)

public RunAggregationQueryResponse.Builder setQuery(AggregationQuery value)

The parsed form of the GqlQuery from the request, if it was set.

.google.datastore.v1.AggregationQuery query = 2;

Parameter
Name Description
value AggregationQuery
Returns
Type Description
RunAggregationQueryResponse.Builder

setQuery(AggregationQuery.Builder builderForValue)

public RunAggregationQueryResponse.Builder setQuery(AggregationQuery.Builder builderForValue)

The parsed form of the GqlQuery from the request, if it was set.

.google.datastore.v1.AggregationQuery query = 2;

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

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

public RunAggregationQueryResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RunAggregationQueryResponse.Builder
Overrides

setTransaction(ByteString value)

public RunAggregationQueryResponse.Builder setTransaction(ByteString value)

The identifier of the transaction that was started as part of this RunAggregationQuery request.

Set only when ReadOptions.new_transaction was set in RunAggregationQueryRequest.read_options.

bytes transaction = 5;

Parameter
Name Description
value ByteString

The transaction to set.

Returns
Type Description
RunAggregationQueryResponse.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RunAggregationQueryResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RunAggregationQueryResponse.Builder
Overrides