Class RunAggregationQueryResponse (3.24.3)

public final class RunAggregationQueryResponse extends GeneratedMessageV3 implements RunAggregationQueryResponseOrBuilder

The response for Firestore.RunAggregationQuery.

Protobuf type google.firestore.v1.RunAggregationQueryResponse

Static Fields

EXPLAIN_METRICS_FIELD_NUMBER

public static final int EXPLAIN_METRICS_FIELD_NUMBER
Field Value
Type Description
int

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_FIELD_NUMBER
Field Value
Type Description
int

RESULT_FIELD_NUMBER

public static final int RESULT_FIELD_NUMBER
Field Value
Type Description
int

TRANSACTION_FIELD_NUMBER

public static final int TRANSACTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RunAggregationQueryResponse getDefaultInstance()
Returns
Type Description
RunAggregationQueryResponse

getDescriptor()

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

newBuilder()

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

newBuilder(RunAggregationQueryResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public RunAggregationQueryResponse getDefaultInstanceForType()
Returns
Type Description
RunAggregationQueryResponse

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.

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

getParserForType()

public Parser<RunAggregationQueryResponse> getParserForType()
Returns
Type Description
Parser<RunAggregationQueryResponse>
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
Type Description
Timestamp

The readTime.

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.

getResultOrBuilder()

public AggregationResultOrBuilder getResultOrBuilder()

A single aggregation result.

Not present when reporting partial progress.

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

Returns
Type Description
AggregationResultOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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 RunAggregationQueryResponse.Builder newBuilderForType()
Returns
Type Description
RunAggregationQueryResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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