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