Cloud Firestore V1 Client - Class RunAggregationQueryResponse (1.27.3)

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

Methods

__construct

Constructor.

Parameters
NameDescription
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 value is valid for.

getResult

A single aggregation result.

Not present when reporting partial progress.

Returns
TypeDescription
Google\Cloud\Firestore\V1\AggregationResult|null

hasResult

clearResult

setResult

A single aggregation result.

Not present when reporting partial progress.

Parameter
NameDescription
var Google\Cloud\Firestore\V1\AggregationResult
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getReadTime

The time at which the aggregate value is valid for.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasReadTime

clearReadTime

setReadTime

The time at which the aggregate value is valid for.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this