Cloud Datastore V1 Client - Class AggregationResultBatch (2.0.3)
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 messagegoogle.datastore.v1.AggregationResultBatch
Namespace
Google \ Cloud \ Datastore \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ aggregation_results | array<AggregationResult>The aggregation results for this batch. |
↳ more_results | intThe 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\TimestampRead 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<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 toNO_MORE_RESULTS.
| Returns | |
|---|---|
| Type | Description |
int | Enum of typeMoreResultsType. |
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 toNO_MORE_RESULTS.
| Parameter | |
|---|---|
| Name | Description |
var | intEnum of typeMoreResultsType. |
| Returns | |
|---|---|
| Type | Description |
$this | |
getReadTime
Read timestamp this batch was returned from.
In a single transaction, subsequent query result batches for the same querycan have a greater timestamp. Each batch's read timestampis 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 querycan have a greater timestamp. Each batch's read timestampis valid for all preceding batches.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Protobuf\Timestamp |
| Returns | |
|---|---|
| Type | Description |
$this | |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-24 UTC.