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
- (::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.
#explain_metrics=
def explain_metrics=(value) -> ::Google::Cloud::Firestore::V1::ExplainMetrics
- value (::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.
- (::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.
#read_time
def read_time() -> ::Google::Protobuf::Timestamp
-
(::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 noresult
will be sent, and this represents the time at which the query was run.
#read_time=
def read_time=(value) -> ::Google::Protobuf::Timestamp
-
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 noresult
will be sent, and this represents the time at which the query was run.
-
(::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 noresult
will be sent, and this represents the time at which the query was run.
#result
def result() -> ::Google::Cloud::Firestore::V1::AggregationResult
-
(::Google::Cloud::Firestore::V1::AggregationResult) — A single aggregation result.
Not present when reporting partial progress.
#result=
def result=(value) -> ::Google::Cloud::Firestore::V1::AggregationResult
-
value (::Google::Cloud::Firestore::V1::AggregationResult) — A single aggregation result.
Not present when reporting partial progress.
-
(::Google::Cloud::Firestore::V1::AggregationResult) — A single aggregation result.
Not present when reporting partial progress.
#transaction
def transaction() -> ::String
-
(::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
-
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.
-
(::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.