Cloud Datastore V1 Client - Class RunAggregationQueryResponse (1.21.2)

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

Methods

__construct

Constructor.

Parameters
NameDescription
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.

getBatch

A batch of aggregation results. Always present.

hasBatch

clearBatch

setBatch

A batch of aggregation results. Always present.

Returns
TypeDescription
$this

getQuery

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

hasQuery

clearQuery

setQuery

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

Parameter
NameDescription
var Google\Cloud\Datastore\V1\AggregationQuery
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this