Class RunAggregationQueryResponse.Builder (3.17.0)

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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RunAggregationQueryResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RunAggregationQueryResponse.Builder
Overrides

build()

public RunAggregationQueryResponse build()
Returns
TypeDescription
RunAggregationQueryResponse

buildPartial()

public RunAggregationQueryResponse buildPartial()
Returns
TypeDescription
RunAggregationQueryResponse

clear()

public RunAggregationQueryResponse.Builder clear()
Returns
TypeDescription
RunAggregationQueryResponse.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public RunAggregationQueryResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
RunAggregationQueryResponse.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public RunAggregationQueryResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
RunAggregationQueryResponse.Builder

clearResult()

public RunAggregationQueryResponse.Builder clearResult()

A single aggregation result.

Not present when reporting partial progress.

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

Returns
TypeDescription
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
TypeDescription
RunAggregationQueryResponse.Builder

This builder for chaining.

clone()

public RunAggregationQueryResponse.Builder clone()
Returns
TypeDescription
RunAggregationQueryResponse.Builder
Overrides

getDefaultInstanceForType()

public RunAggregationQueryResponse getDefaultInstanceForType()
Returns
TypeDescription
RunAggregationQueryResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getResult()

public AggregationResult getResult()

A single aggregation result.

Not present when reporting partial progress.

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

Returns
TypeDescription
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
TypeDescription
AggregationResult.Builder

getResultOrBuilder()

public AggregationResultOrBuilder getResultOrBuilder()

A single aggregation result.

Not present when reporting partial progress.

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

Returns
TypeDescription
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
TypeDescription
ByteString

The transaction.

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
TypeDescription
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
TypeDescription
boolean

Whether the result field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(RunAggregationQueryResponse other)

public RunAggregationQueryResponse.Builder mergeFrom(RunAggregationQueryResponse other)
Parameter
NameDescription
otherRunAggregationQueryResponse
Returns
TypeDescription
RunAggregationQueryResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RunAggregationQueryResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunAggregationQueryResponse.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public RunAggregationQueryResponse.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
valueAggregationResult
Returns
TypeDescription
RunAggregationQueryResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RunAggregationQueryResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RunAggregationQueryResponse.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public RunAggregationQueryResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
RunAggregationQueryResponse.Builder

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

public RunAggregationQueryResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valueAggregationResult
Returns
TypeDescription
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
NameDescription
builderForValueAggregationResult.Builder
Returns
TypeDescription
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
NameDescription
valueByteString

The transaction to set.

Returns
TypeDescription
RunAggregationQueryResponse.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RunAggregationQueryResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RunAggregationQueryResponse.Builder
Overrides