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.
#query
def query() -> ::Google::Cloud::Datastore::V1::AggregationQuery
Returns
-
(::Google::Cloud::Datastore::V1::AggregationQuery) — The parsed form of the
GqlQueryfrom 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
GqlQueryfrom the request, if it was set.
Returns
-
(::Google::Cloud::Datastore::V1::AggregationQuery) — The parsed form of the
GqlQueryfrom the request, if it was set.
#stats
def stats() -> ::Google::Cloud::Datastore::V1::ResultSetStats
Returns
-
(::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.
#stats=
def stats=(value) -> ::Google::Cloud::Datastore::V1::ResultSetStats
Parameter
-
value (::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.
Returns
-
(::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.
#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.