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

getResult

A single aggregation result.

Not present when reporting partial progress.

Returns
Type
Description

hasResult

clearResult

setResult

A single aggregation result.

Not present when reporting partial progress.

Parameter
Name
Description
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 value is valid for.

Returns
Type
Description

hasReadTime

clearReadTime

setReadTime

The time at which the aggregate value is valid for.

Parameter
Name
Description
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: