Cloud Datastore V1 Client - Class RunAggregationQueryResponse (1.32.0)

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.
`↳ explain_metrics`	`Google\Cloud\Datastore\V1\ExplainMetrics` Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.

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`

getExplainMetrics

Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.

Returns
Type	Description
`Google\Cloud\Datastore\V1\ExplainMetrics\|null`

hasExplainMetrics

clearExplainMetrics

setExplainMetrics

Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.

Parameter
Name	Description
`var`	`Google\Cloud\Datastore\V1\ExplainMetrics`

Returns
Type	Description
`$this`