Firestore API - Class AggregateQuery (3.5.0)

Version 3.5.0

• 3.9.0 (latest)
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.1
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.5.0
• 2.4.0
• 2.3.1

public sealed class AggregateQuery : IEquatable<AggregateQuery>

Reference documentation and code samples for the Firestore API class AggregateQuery.

A query for running server-side aggregations. Instances of this can be created using Count() and Aggregate(AggregateField, params AggregateField[]).

Inheritance

object > AggregateQuery

Implements

IEquatableAggregateQuery

Inherited Members

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore

Assembly

Google.Cloud.Firestore.dll

Methods

GetHashCode()

public override int GetHashCode()

Serves as the default hash function.

Returns
Type	Description
int	A hash code for the current object.

Overrides

object.GetHashCode()

GetSnapshotAsync(CancellationToken)

public Task<AggregateQuerySnapshot> GetSnapshotAsync(CancellationToken cancellationToken = default)

Asynchronously takes a snapshot of the result after applying the aggregate functions on the query.

Parameter
Name	Description
cancellationToken	CancellationToken A cancellation token for the operation.

Returns
Type	Description
TaskAggregateQuerySnapshot	A AggregateQuerySnapshot which contains results of the Aggregate functions.