Class: Google::Apis::FirestoreV1::Avg

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

Average of the values of the requested field. * Only numeric values will be aggregated. All non-numeric values including NULL are skipped. * If the aggregated values contain NaN, returns NaN. Infinity math follows IEEE-754 standards. * If the aggregated value set is empty, returns NULL. * Always returns the result as a double.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Avg

Returns a new instance of Avg.



141
142
143
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 141

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

Instance Attribute Details

#field ⇒ Google::Apis::FirestoreV1::FieldReference

A reference to a field in a document, ex: stats.operations. Corresponds to the JSON property field

Returns:



139
140
141
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 139

def field
  @field
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



146
147
148
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 146

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