Class: Google::Cloud::Firestore::V1::AggregationResult

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/firestore/v1/aggregation_result.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.

Defined Under Namespace

Classes: AggregateFieldsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#aggregate_fields ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}

Returns 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.



37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'proto_docs/google/firestore/v1/aggregation_result.rb', line 37

class AggregationResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Firestore::V1::Value]
  class AggregateFieldsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end