Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::AggregationResult (v0.12.0)

Version 0.12.0

• 1.2.0 (latest)
• 1.1.1
• 1.0.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.8

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

The result of a single bucket from a Firestore aggregation query.

The keys of aggregate_fields are the same for all results in an aggregation query, unlike document queries which can have different fields present for each result.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#aggregate_fields

def aggregate_fields() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}

Returns

• (::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}) — The result of the aggregation functions, ex: COUNT(*) AS total_docs.

  The key is the alias assigned to the aggregation function on input and the size of this map equals the number of aggregation functions in the query.

#aggregate_fields=

def aggregate_fields=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}

Parameter

• value (::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}) — The result of the aggregation functions, ex: COUNT(*) AS total_docs.

  The key is the alias assigned to the aggregation function on input and the size of this map equals the number of aggregation functions in the query.

Returns

• (::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}) — The result of the aggregation functions, ex: COUNT(*) AS total_docs.

  The key is the alias assigned to the aggregation function on input and the size of this map equals the number of aggregation functions in the query.