Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::RunAggregationQueryResponse (v0.13.0)

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

The response for Firestore.RunAggregationQuery.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#explain_metrics

def explain_metrics() -> ::Google::Cloud::Firestore::V1::ExplainMetrics
Returns

#explain_metrics=

def explain_metrics=(value) -> ::Google::Cloud::Firestore::V1::ExplainMetrics
Parameter
Returns

#read_time

def read_time() -> ::Google::Protobuf::Timestamp
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.

#read_time=

def read_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::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.

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.

#result

def result() -> ::Google::Cloud::Firestore::V1::AggregationResult
Returns

#result=

def result=(value) -> ::Google::Cloud::Firestore::V1::AggregationResult
Parameter
Returns

#transaction

def transaction() -> ::String
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.

#transaction=

def transaction=(value) -> ::String
Parameter
  • value (::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.

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.