GoogleApi.Firestore.V1.Model.Aggregation (google_api_firestore v0.33.0)

Defines an aggregation that produces a single result.

Attributes

alias (type: String.t, default: nil) - Optional. Optional name of the field to store the result of the aggregation into. If not provided, Firestore will pick a default name following the format field_. For example: AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2), COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) OVER ( ... ); becomes: AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2) AS field_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) AS field_2 OVER ( ... ); Requires: Must be unique across all aggregation aliases. Conform to document field name limitations.
avg (type: GoogleApi.Firestore.V1.Model.Avg.t, default: nil) - Average aggregator.
count (type: GoogleApi.Firestore.V1.Model.Count.t, default: nil) - Count aggregator.
sum (type: GoogleApi.Firestore.V1.Model.Sum.t, default: nil) - Sum aggregator.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Firestore.V1.Model.Aggregation{
  alias: String.t() | nil,
  avg: GoogleApi.Firestore.V1.Model.Avg.t() | nil,
  count: GoogleApi.Firestore.V1.Model.Count.t() | nil,
  sum: GoogleApi.Firestore.V1.Model.Sum.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.