Cloud Firestore V1 Client - Class RunAggregationQueryResponse (1.44.1)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ result Google\Cloud\Firestore\V1\AggregationResult

A single aggregation result. Not present when reporting partial progress.

↳ 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 Google\Cloud\Firestore\V1\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.

Returns
Type Description
Google\Cloud\Firestore\V1\AggregationResult|null

hasResult

clearResult

setResult

A single aggregation result.

Not present when reporting partial progress.

Parameter
Name Description
var Google\Cloud\Firestore\V1\AggregationResult
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
Google\Protobuf\Timestamp|null

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.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$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.

Returns
Type Description
Google\Cloud\Firestore\V1\ExplainMetrics|null

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.

Parameter
Name Description
var Google\Cloud\Firestore\V1\ExplainMetrics
Returns
Type Description
$this