Class RunAggregationQueryResponse.Builder (3.26.5)

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

The response for Firestore.RunAggregationQuery.

Protobuf type google.firestore.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

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.firestore.v1.ExplainMetrics explain_metrics = 10;

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

clearReadTime()

public RunAggregationQueryResponse.Builder clearReadTime()

The time at which the aggregate result was computed. This is always monotonically increasing; in this case, the previous AggregationResult in the result stream are guaranteed not to have changed between their read_time and this one.

If the query returns no results, a response with read_time and no result will be sent, and this represents the time at which the query was run.

.google.protobuf.Timestamp read_time = 3;

Returns
Type Description
RunAggregationQueryResponse.Builder

clearResult()

public RunAggregationQueryResponse.Builder clearResult()

A single aggregation result.

Not present when reporting partial progress.

.google.firestore.v1.AggregationResult result = 1;

Returns
Type Description
RunAggregationQueryResponse.Builder

clearTransaction()

public RunAggregationQueryResponse.Builder clearTransaction()

The transaction that was started as part of this request.

Only present on the first response when the request requested to start a new transaction.

bytes transaction = 2;

Returns
Type Description
RunAggregationQueryResponse.Builder

This builder for chaining.

clone()

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

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.firestore.v1.ExplainMetrics explain_metrics = 10;

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.firestore.v1.ExplainMetrics explain_metrics = 10;

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.firestore.v1.ExplainMetrics explain_metrics = 10;

Returns
Type Description
ExplainMetricsOrBuilder

getReadTime()

public Timestamp getReadTime()

The time at which the aggregate result was computed. This is always monotonically increasing; in this case, the previous AggregationResult in the result stream are guaranteed not to have changed between their read_time and this one.

If the query returns no results, a response with read_time and no result will be sent, and this represents the time at which the query was run.

.google.protobuf.Timestamp read_time = 3;

Returns
Type Description
Timestamp

The readTime.

getReadTimeBuilder()

public Timestamp.Builder getReadTimeBuilder()

The time at which the aggregate result was computed. This is always monotonically increasing; in this case, the previous AggregationResult in the result stream are guaranteed not to have changed between their read_time and this one.

If the query returns no results, a response with read_time and no result will be sent, and this represents the time at which the query was run.

.google.protobuf.Timestamp read_time = 3;

Returns
Type Description
Builder

getReadTimeOrBuilder()

public TimestampOrBuilder getReadTimeOrBuilder()

The time at which the aggregate result was computed. This is always monotonically increasing; in this case, the previous AggregationResult in the result stream are guaranteed not to have changed between their read_time and this one.

If the query returns no results, a response with read_time and no result will be sent, and this represents the time at which the query was run.

.google.protobuf.Timestamp read_time = 3;

Returns
Type Description
TimestampOrBuilder

getResult()

public AggregationResult getResult()

A single aggregation result.

Not present when reporting partial progress.

.google.firestore.v1.AggregationResult result = 1;

Returns
Type Description
AggregationResult

The result.

getResultBuilder()

public AggregationResult.Builder getResultBuilder()

A single aggregation result.

Not present when reporting partial progress.

.google.firestore.v1.AggregationResult result = 1;

Returns
Type Description
AggregationResult.Builder

getResultOrBuilder()

public AggregationResultOrBuilder getResultOrBuilder()

A single aggregation result.

Not present when reporting partial progress.

.google.firestore.v1.AggregationResult result = 1;

Returns
Type Description
AggregationResultOrBuilder

getTransaction()

public ByteString getTransaction()

The transaction that was started as part of this request.

Only present on the first response when the request requested to start a new transaction.

bytes transaction = 2;

Returns
Type Description
ByteString

The transaction.

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.firestore.v1.ExplainMetrics explain_metrics = 10;

Returns
Type Description
boolean

Whether the explainMetrics field is set.

hasReadTime()

public boolean hasReadTime()

The time at which the aggregate result was computed. This is always monotonically increasing; in this case, the previous AggregationResult in the result stream are guaranteed not to have changed between their read_time and this one.

If the query returns no results, a response with read_time and no result will be sent, and this represents the time at which the query was run.

.google.protobuf.Timestamp read_time = 3;

Returns
Type Description
boolean

Whether the readTime field is set.

hasResult()

public boolean hasResult()

A single aggregation result.

Not present when reporting partial progress.

.google.firestore.v1.AggregationResult result = 1;

Returns
Type Description
boolean

Whether the result field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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.firestore.v1.ExplainMetrics explain_metrics = 10;

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

mergeReadTime(Timestamp value)

public RunAggregationQueryResponse.Builder mergeReadTime(Timestamp value)

The time at which the aggregate result was computed. This is always monotonically increasing; in this case, the previous AggregationResult in the result stream are guaranteed not to have changed between their read_time and this one.

If the query returns no results, a response with read_time and no result will be sent, and this represents the time at which the query was run.

.google.protobuf.Timestamp read_time = 3;

Parameter
Name Description
value Timestamp
Returns
Type Description
RunAggregationQueryResponse.Builder

mergeResult(AggregationResult value)

public RunAggregationQueryResponse.Builder mergeResult(AggregationResult value)

A single aggregation result.

Not present when reporting partial progress.

.google.firestore.v1.AggregationResult result = 1;

Parameter
Name Description
value AggregationResult
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

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.firestore.v1.ExplainMetrics explain_metrics = 10;

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.firestore.v1.ExplainMetrics explain_metrics = 10;

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

setReadTime(Timestamp value)

public RunAggregationQueryResponse.Builder setReadTime(Timestamp value)

The time at which the aggregate result was computed. This is always monotonically increasing; in this case, the previous AggregationResult in the result stream are guaranteed not to have changed between their read_time and this one.

If the query returns no results, a response with read_time and no result will be sent, and this represents the time at which the query was run.

.google.protobuf.Timestamp read_time = 3;

Parameter
Name Description
value Timestamp
Returns
Type Description
RunAggregationQueryResponse.Builder

setReadTime(Timestamp.Builder builderForValue)

public RunAggregationQueryResponse.Builder setReadTime(Timestamp.Builder builderForValue)

The time at which the aggregate result was computed. This is always monotonically increasing; in this case, the previous AggregationResult in the result stream are guaranteed not to have changed between their read_time and this one.

If the query returns no results, a response with read_time and no result will be sent, and this represents the time at which the query was run.

.google.protobuf.Timestamp read_time = 3;

Parameter
Name Description
builderForValue 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

setResult(AggregationResult value)

public RunAggregationQueryResponse.Builder setResult(AggregationResult value)

A single aggregation result.

Not present when reporting partial progress.

.google.firestore.v1.AggregationResult result = 1;

Parameter
Name Description
value AggregationResult
Returns
Type Description
RunAggregationQueryResponse.Builder

setResult(AggregationResult.Builder builderForValue)

public RunAggregationQueryResponse.Builder setResult(AggregationResult.Builder builderForValue)

A single aggregation result.

Not present when reporting partial progress.

.google.firestore.v1.AggregationResult result = 1;

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

setTransaction(ByteString value)

public RunAggregationQueryResponse.Builder setTransaction(ByteString value)

The transaction that was started as part of this request.

Only present on the first response when the request requested to start a new transaction.

bytes transaction = 2;

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