Class: Google::Cloud::Firestore::V1::RunAggregationQueryResponse

Inherits:

Object

• Object
• Google::Cloud::Firestore::V1::RunAggregationQueryResponse

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/firestore/v1/firestore.rb

Overview

The response for Firestore.RunAggregationQuery.

Instance Attribute Summary

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

  Query explain metrics.

• #read_time ⇒ ::Google::Protobuf::Timestamp

  The time at which the aggregate result was computed.

• #result ⇒ ::Google::Cloud::Firestore::V1::AggregationResult

  A single aggregation result.

• #transaction ⇒ ::String

  The transaction that was started as part of this request.

Instance Attribute Details

#explain_metrics ⇒ ::Google::Cloud::Firestore::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::Firestore::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/firestore/v1/firestore.rb', line 496

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

#read_time ⇒ ::Google::Protobuf::Timestamp

Returns The time at which the aggregate result was computed. This is always monotonically increasing; in this case, the previous AggregationResult in the result stream are guaranteed not to have changed between their read_time and this one.

If the query returns no results, a response with read_time and no result will be sent, and this represents the time at which the query was run.

Returns:

• (::Google::Protobuf::Timestamp) —

  The time at which the aggregate result was computed. This is always monotonically increasing; in this case, the previous AggregationResult in the result stream are guaranteed not to have changed between their read_time and this one.

  If the query returns no results, a response with read_time and no result will be sent, and this represents the time at which the query was run.

# File 'proto_docs/google/firestore/v1/firestore.rb', line 496

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

#result ⇒ ::Google::Cloud::Firestore::V1::AggregationResult

Returns A single aggregation result.

Not present when reporting partial progress.

Returns:

• (::Google::Cloud::Firestore::V1::AggregationResult) —

  A single aggregation result.

  Not present when reporting partial progress.

# File 'proto_docs/google/firestore/v1/firestore.rb', line 496

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

#transaction ⇒ ::String

Returns The transaction that was started as part of this request.

Only present on the first response when the request requested to start a new transaction.

Returns:

• (::String) —

  The transaction that was started as part of this request.

  Only present on the first response when the request requested to start a new transaction.

# File 'proto_docs/google/firestore/v1/firestore.rb', line 496

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