Show / Hide Table of Contents

Class Aggregation

Defines an aggregation that produces a single result.

Inheritance
object
Aggregation
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Firestore.v1.Data
Assembly: Google.Apis.Firestore.v1.dll
Syntax
public class Aggregation : IDirectResponseSchema

Properties

Alias

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.

Declaration
[JsonProperty("alias")]
public virtual string Alias { get; set; }
Property Value
Type Description
string

Avg

Average aggregator.

Declaration
[JsonProperty("avg")]
public virtual Avg Avg { get; set; }
Property Value
Type Description
Avg

Count

Count aggregator.

Declaration
[JsonProperty("count")]
public virtual Count Count { get; set; }
Property Value
Type Description
Count

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Sum

Sum aggregator.

Declaration
[JsonProperty("sum")]
public virtual Sum Sum { get; set; }
Property Value
Type Description
Sum

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX