Cloud Firestore V1 Client - Class RunAggregationQueryResponse (1.38.0)

Version 1.38.0

• 1.47.1 (latest)
• 1.47.0
• 1.46.0
• 1.45.2
• 1.44.1
• 1.43.3
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 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

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.

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