Class: Google::Apis::FirestoreV1::AggregationResult

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firestore_v1/classes.rb,
lib/google/apis/firestore_v1/representations.rb,
lib/google/apis/firestore_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AggregationResult

Returns a new instance of AggregationResult.



99
100
101
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 99

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#aggregate_fields ⇒ Hash<String,Google::Apis::FirestoreV1::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. Corresponds to the JSON property aggregateFields

Returns:



97
98
99
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 97

def aggregate_fields
  @aggregate_fields
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



104
105
106
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 104

def update!(**args)
  @aggregate_fields = args[:aggregate_fields] if args.key?(:aggregate_fields)
end