Reference documentation and code samples for the Cloud Datastore V1 Client class AggregationResultBatch.
A batch of aggregation results produced by an aggregation query.
Generated from protobuf message google.datastore.v1.AggregationResultBatch
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ aggregation_results |
array<Google\Cloud\Datastore\V1\AggregationResult>
The aggregation results for this batch. |
↳ more_results |
int
The state of the query after the current batch. Only COUNT(*) aggregations are supported in the initial launch. Therefore, expected result type is limited to |
↳ read_time |
Google\Protobuf\Timestamp
Read timestamp this batch was returned from. In a single transaction, subsequent query result batches for the same query can have a greater timestamp. Each batch's read timestamp is valid for all preceding batches. |
getAggregationResults
The aggregation results for this batch.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setAggregationResults
The aggregation results for this batch.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Datastore\V1\AggregationResult>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMoreResults
The state of the query after the current batch.
Only COUNT(*) aggregations are supported in the initial launch. Therefore,
expected result type is limited to NO_MORE_RESULTS.
| Returns | |
|---|---|
| Type | Description |
int | |
setMoreResults
The state of the query after the current batch.
Only COUNT(*) aggregations are supported in the initial launch. Therefore,
expected result type is limited to NO_MORE_RESULTS.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReadTime
Read timestamp this batch was returned from.
In a single transaction, subsequent query result batches for the same query can have a greater timestamp. Each batch's read timestamp is valid for all preceding batches.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasReadTime
clearReadTime
setReadTime
Read timestamp this batch was returned from.
In a single transaction, subsequent query result batches for the same query can have a greater timestamp. Each batch's read timestamp is valid for all preceding batches.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |