Cloud Datastore V1 Client - Class RunAggregationQueryResponse (1.26.0)

Version 1.26.0

• 1.32.2 (latest)
• 1.32.1
• 1.31.0
• 1.30.0
• 1.29.2
• 1.28.2
• 1.26.0
• 1.25.0
• 1.24.4
• 1.23.0
• 1.22.1
• 1.21.2
• 1.19.0
• 1.18.1
• 1.17.1

Reference documentation and code samples for the Cloud Datastore V1 Client class RunAggregationQueryResponse.

The response for Datastore.RunAggregationQuery.

Generated from protobuf message google.datastore.v1.RunAggregationQueryResponse

Namespace

Google \ Cloud \ Datastore \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ batch	Google\Cloud\Datastore\V1\AggregationResultBatch A batch of aggregation results. Always present.
↳ query	Google\Cloud\Datastore\V1\AggregationQuery The parsed form of the GqlQuery from the request, if it was set.
↳ transaction	string The identifier of the transaction that was started as part of this RunAggregationQuery request. Set only when ReadOptions.new_transaction was set in RunAggregationQueryRequest.read_options.
↳ stats	Google\Cloud\Datastore\V1\ResultSetStats Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than NORMAL.

getBatch

A batch of aggregation results. Always present.

Returns
Type	Description
Google\Cloud\Datastore\V1\AggregationResultBatch|null

hasBatch

clearBatch

setBatch

A batch of aggregation results. Always present.

Parameter
Name	Description
var	Google\Cloud\Datastore\V1\AggregationResultBatch

Returns
Type	Description
$this

getQuery

The parsed form of the GqlQuery from the request, if it was set.

Returns
Type	Description
Google\Cloud\Datastore\V1\AggregationQuery|null

hasQuery

clearQuery

setQuery

The parsed form of the GqlQuery from the request, if it was set.

Parameter
Name	Description
var	Google\Cloud\Datastore\V1\AggregationQuery

Returns
Type	Description
$this

getTransaction

The identifier of the transaction that was started as part of this RunAggregationQuery request.

Set only when ReadOptions.new_transaction was set in RunAggregationQueryRequest.read_options.

Returns
Type	Description
string

setTransaction

The identifier of the transaction that was started as part of this RunAggregationQuery request.

Set only when ReadOptions.new_transaction was set in RunAggregationQueryRequest.read_options.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getStats

Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves.

This is only present when the request specifies a mode other than NORMAL.

Returns
Type	Description
Google\Cloud\Datastore\V1\ResultSetStats|null

hasStats

clearStats

setStats

Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves.

This is only present when the request specifies a mode other than NORMAL.

Parameter
Name	Description
var	Google\Cloud\Datastore\V1\ResultSetStats

Returns
Type	Description
$this