AggregateQuery

classAggregateQuery

A query that calculates aggregations over an underlying query.

Subclassing Note: Cloud Firestore classes are not meant to be subclassed except for use in test mocks. Subclassing is not supported in production code and new SDK releases may break code that does so.

Summary

Public functions

Boolean
equals(object: Any!)

Compares this object with the given object for equality.

Task<AggregateQuerySnapshot!>

Executes this query.

Int

Calculates and returns the hash code for this object.

Public properties

Query

Public functions

equals

fun equals(object: Any!): Boolean

Compares this object with the given object for equality.

This object is considered "equal" to the other object if and only if all of the following conditions are satisfied:

  1. object is a non-null instance ofAggregateQuery.
  2. object performs the same aggregations as thisAggregateQuery.
  3. The underlyingQuery ofobject compares equal to that of this object.
Parameters
object: Any!

The object to compare to this object for equality.

Returns
Boolean

true if this object is "equal" to the given object, as defined above, or false otherwise.

get

fun get(source: AggregateSource): Task<AggregateQuerySnapshot!>

Executes this query.

Parameters
source: AggregateSource

The source from which to acquire the aggregate results.

Returns
Task<AggregateQuerySnapshot!>

ATask that will be resolved with the results of the query.

hashCode

fun hashCode(): Int

Calculates and returns the hash code for this object.

Returns
Int

the hash code for this object.

Public properties

query

val query: Query

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-21 UTC.