Class: Google::Cloud::Datastore::V1::RunAggregationQueryResponse

Inherits:

Object

• Object
• Google::Cloud::Datastore::V1::RunAggregationQueryResponse

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/datastore/v1/datastore.rb

Overview

The response for Datastore.RunAggregationQuery.

Instance Attribute Summary

• #batch ⇒ ::Google::Cloud::Datastore::V1::AggregationResultBatch

  A batch of aggregation results.

• #explain_metrics ⇒ ::Google::Cloud::Datastore::V1::ExplainMetrics

  Query explain metrics.

• #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.

Instance Attribute Details

#batch ⇒ ::Google::Cloud::Datastore::V1::AggregationResultBatch

Returns A batch of aggregation results. Always present.

Returns:

• (::Google::Cloud::Datastore::V1::AggregationResultBatch) —

  A batch of aggregation results. Always present.

# File 'proto_docs/google/datastore/v1/datastore.rb', line 211

class RunAggregationQueryResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#explain_metrics ⇒ ::Google::Cloud::Datastore::V1::ExplainMetrics

Returns 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.

# File 'proto_docs/google/datastore/v1/datastore.rb', line 211

class RunAggregationQueryResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#query ⇒ ::Google::Cloud::Datastore::V1::AggregationQuery

Returns 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.

# File 'proto_docs/google/datastore/v1/datastore.rb', line 211

class RunAggregationQueryResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#transaction ⇒ ::String

Returns 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.

# File 'proto_docs/google/datastore/v1/datastore.rb', line 211

class RunAggregationQueryResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end