Reference documentation and code samples for the Cloud Firestore V1 Client class RunAggregationQueryResponse.
The response for Firestore.RunAggregationQuery .
Generated from protobuf message google.firestore.v1.RunAggregationQueryResponse
Namespace
Google \ Cloud \ Firestore \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ result
↳ transaction
string
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
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
ExplainMetrics
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.
getResult
A single aggregation result.
Not present when reporting partial progress.
hasResult
clearResult
setResult
A single aggregation result.
Not present when reporting partial progress.
$this
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.
string
setTransaction
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.
var
string
$this
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.
hasReadTime
clearReadTime
setReadTime
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.
$this
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.
hasExplainMetrics
clearExplainMetrics
setExplainMetrics
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.
$this
