Class RunAggregationQueryResponse (2.16.0)

RunAggregationQueryResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The response for Firestore.RunAggregationQuery][google.firestore.v1.Firestore.RunAggregationQuery].

Attributes

NameDescription
result google.cloud.firestore_v1.types.AggregationResult
A single aggregation result. Not present when reporting partial progress.
transaction bytes
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.
read_time google.protobuf.timestamp_pb2.Timestamp
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.
explain_metrics google.cloud.firestore_v1.types.ExplainMetrics
Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options][google.firestore.v1.RunAggregationQueryRequest.explain_options] is provided, and it is sent only once with the last response in the stream.