AggregateField

abstract classAggregateField

Known direct subclasses
AggregateField.AverageAggregateField

Represents an "average" aggregation that can be performed by Firestore.

AggregateField.CountAggregateField

Represents a "count" aggregation that can be performed by Firestore.

AggregateField.SumAggregateField

Represents a "sum" aggregation that can be performed by Firestore.

Represents an aggregation that can be performed by Firestore.

Summary

Nested types

Represents an "average" aggregation that can be performed by Firestore.

Represents a "count" aggregation that can be performed by Firestore.

Represents a "sum" aggregation that can be performed by Firestore.

Public functions

java-staticAggregateField.AverageAggregateField
average(field: String)

Create anAverageAggregateField object that can be used to compute the average of a specified field over a range of documents in the result set of a query.

java-staticAggregateField.AverageAggregateField
average(fieldPath: FieldPath)

Create anAverageAggregateField object that can be used to compute the average of a specified field over a range of documents in the result set of a query.

java-staticAggregateField.CountAggregateField

Create aCountAggregateField object that can be used to compute the count of documents in the result set of a query.

Boolean
equals(other: Any!)

Returns true if the given object is equal to this object.

Int

Calculates and returns the hash code for this object.

java-staticAggregateField.SumAggregateField
sum(field: String)

Create aSumAggregateField object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.

java-staticAggregateField.SumAggregateField
sum(fieldPath: FieldPath)

Create aSumAggregateField object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.

Public properties

String
String

Public functions

average

java-static fun average(field: String): AggregateField.AverageAggregateField

Create anAverageAggregateField object that can be used to compute the average of a specified field over a range of documents in the result set of a query.

The result of an average operation will always be a double or NaN.

  • Averaging over zero documents or fields will result in a double value representing NaN.
  • Averaging over NaN will result in a double value representing NaN.
Parameters
field: String

Specifies the field to average across the result set.

Returns
AggregateField.AverageAggregateField

The `AverageAggregateField` object that can be used to compute the average of a specified field over a range of documents in the result set of a query.

average

java-static fun average(fieldPath: FieldPath): AggregateField.AverageAggregateField

Create anAverageAggregateField object that can be used to compute the average of a specified field over a range of documents in the result set of a query.

The result of an average operation will always be a double or NaN.

  • Averaging over zero documents or fields will result in a double value representing NaN.
  • Averaging over NaN will result in a double value representing NaN.
Parameters
fieldPath: FieldPath

Specifies the field to average across the result set.

Returns
AggregateField.AverageAggregateField

The `AverageAggregateField` object that can be used to compute the average of a specified field over a range of documents in the result set of a query.

count

java-static fun count(): AggregateField.CountAggregateField

Create aCountAggregateField object that can be used to compute the count of documents in the result set of a query.

The result of a count operation will always be a 64-bit integer value.

Returns
AggregateField.CountAggregateField

The `CountAggregateField` object that can be used to compute the count of documents in the result set of a query.

equals

fun equals(other: Any!): Boolean

Returns true if the given object is equal to this object. Two `AggregateField` objects are considered equal if they have the same operator and operate on the same field.

hashCode

fun hashCode(): Int

Calculates and returns the hash code for this object.

sum

java-static fun sum(field: String): AggregateField.SumAggregateField

Create aSumAggregateField object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.

The result of a sum operation will always be a 64-bit integer value, a double, or NaN.

  • Summing over zero documents or fields will result in 0L.
  • Summing over NaN will result in a double value representing NaN.
  • A sum that overflows the maximum representable 64-bit integer value will result in a double return value. This may result in lost precision of the result.
  • A sum that overflows the maximum representable double value will result in a double return value representing infinity.
Parameters
field: String

Specifies the field to sum across the result set.

Returns
AggregateField.SumAggregateField

The `SumAggregateField` object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.

sum

java-static fun sum(fieldPath: FieldPath): AggregateField.SumAggregateField

Create aSumAggregateField object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.

The result of a sum operation will always be a 64-bit integer value, a double, or NaN.

  • Summing over zero documents or fields will result in 0L.
  • Summing over NaN will result in a double value representing NaN.
  • A sum that overflows the maximum representable 64-bit integer value will result in a double return value. This may result in lost precision of the result.
  • A sum that overflows the maximum representable double value will result in a double return value representing infinity.
Parameters
fieldPath: FieldPath

Specifies the field to sum across the result set.

Returns
AggregateField.SumAggregateField

The `SumAggregateField` object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.

Public properties

alias

val alias: String

operator

val operator: String

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.