Firestore in Datastore mode V1 API - Class Google::Cloud::Datastore::V1::RunAggregationQueryResponse (v0.18.0)

Version latest

• 0.18.0 (latest)
• 0.17.0
• 0.16.3
• 0.15.0
• 0.14.0
• 0.13.1
• 0.12.0
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.5

Reference documentation and code samples for the Firestore in Datastore mode V1 API class Google::Cloud::Datastore::V1::RunAggregationQueryResponse.

The response for Datastore.RunAggregationQuery.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#batch

def batch() -> ::Google::Cloud::Datastore::V1::AggregationResultBatch

Returns

• (::Google::Cloud::Datastore::V1::AggregationResultBatch) — A batch of aggregation results. Always present.

#batch=

def batch=(value) -> ::Google::Cloud::Datastore::V1::AggregationResultBatch

Parameter

• value (::Google::Cloud::Datastore::V1::AggregationResultBatch) — A batch of aggregation results. Always present.

Returns

• (::Google::Cloud::Datastore::V1::AggregationResultBatch) — A batch of aggregation results. Always present.

#explain_metrics

def explain_metrics() -> ::Google::Cloud::Datastore::V1::ExplainMetrics

Returns

• (::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.

#explain_metrics=

def explain_metrics=(value) -> ::Google::Cloud::Datastore::V1::ExplainMetrics

Parameter

• value (::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.

Returns

• (::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.

#query

def query() -> ::Google::Cloud::Datastore::V1::AggregationQuery

Returns

• (::Google::Cloud::Datastore::V1::AggregationQuery) — The parsed form of the GqlQuery from the request, if it was set.

#query=

def query=(value) -> ::Google::Cloud::Datastore::V1::AggregationQuery

Parameter

• value (::Google::Cloud::Datastore::V1::AggregationQuery) — The parsed form of the GqlQuery from the request, if it was set.

Returns

• (::Google::Cloud::Datastore::V1::AggregationQuery) — The parsed form of the GqlQuery from the request, if it was set.

#transaction

def transaction() -> ::String

Returns

• (::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.

#transaction=

def transaction=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.