Cloud Datastore V1 Client - Class AggregationResultBatch (1.17.1)

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 `NO_MORE_RESULTS`.
`↳ 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.

Generated from protobuf field repeated .google.datastore.v1.AggregationResult aggregation_results = 1;

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setAggregationResults

The aggregation results for this batch.

Generated from protobuf field repeated .google.datastore.v1.AggregationResult aggregation_results = 1;

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.

Generated from protobuf field .google.datastore.v1.QueryResultBatch.MoreResultsType more_results = 2;

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.

Generated from protobuf field .google.datastore.v1.QueryResultBatch.MoreResultsType more_results = 2;

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.

Generated from protobuf field .google.protobuf.Timestamp read_time = 3;

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.

Generated from protobuf field .google.protobuf.Timestamp read_time = 3;

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`