Cloud Datastore V1 Client - Class RunAggregationQueryResponse (1.33.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
AggregationResultBatch

A batch of aggregation results. Always present.

↳ query
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
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

hasBatch

clearBatch

setBatch

A batch of aggregation results. Always present.

Parameter
Name
Description
Returns
Type
Description
$this

getQuery

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

Returns
Type
Description

hasQuery

clearQuery

setQuery

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

Parameter
Name
Description
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

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
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: