IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

AggregateOptions

public final class AggregateOptions extends AbstractOptions

java.lang.Object
↳	com.google.firebase.firestore.pipeline.AbstractOptions
	↳	com.google.firebase.firestore.pipeline.AggregateOptions

Summary

Public constructors
`AggregateOptions()` Creates a new, empty `AggregateOptions` object.

Public methods
`@NonNull AggregateOptions`	`self(@NonNull InternalOptions options)`
`final @NonNull AggregateOptions`	`withHints(@NonNull AggregateHints hints)` Specifies query hints for the aggregation.

Inherited methods

From com.google.firebase.firestore.pipeline.AbstractOptions

`final @NonNull AggregateOptions`	`adding(@NonNull AbstractOptions<@NonNull ?> newOptions)`
`final @NonNull AggregateOptions`	`with(@NonNull String key, @NonNull AbstractOptions<@NonNull ?> subSection)`
`final @NonNull AggregateOptions`	`with(@NonNull String key, @NonNull <Error class: unknown class> value)`
`final @NonNull AggregateOptions`	`with(@NonNull String key, boolean value)` Specify generic `Boolean` option
`final @NonNull AggregateOptions`	`with(@NonNull String key, double value)` Specify generic `Double` option
`final @NonNull AggregateOptions`	`with(@NonNull String key, @NonNull Field value)` Specify generic `Field` option
`final @NonNull AggregateOptions`	`with(@NonNull String key, @NonNull InternalOptions value)`
`final @NonNull AggregateOptions`	`with(@NonNull String key, long value)` Specify generic `Long` option
`final @NonNull AggregateOptions`	`with(@NonNull String key, @NonNull RawOptions value)` Specify `RawOptions` object
`final @NonNull AggregateOptions`	`with(@NonNull String key, @NonNull String value)` Specify generic `String` option
`final @NonNull AggregateOptions`	`with(@NonNull String key, @NonNull String values)`

Public constructors

AggregateOptions

public AggregateOptions()

Creates a new, empty AggregateOptions object.

Public methods

self

public @NonNull AggregateOptions self(@NonNull InternalOptions options)

withHints

public final @NonNull AggregateOptions withHints(@NonNull AggregateHints hints)

Specifies query hints for the aggregation.

Parameters
`@NonNull AggregateHints hints`	The hints to apply to the aggregation.

Returns
`@NonNull AggregateOptions`	A new `AggregateOptions` with the specified hints.