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.

AggregateHints

public final class AggregateHints extends AbstractOptions

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

Summary

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

Public methods
`@NonNull AggregateHints`	`self(@NonNull InternalOptions options)`
`final @NonNull AggregateHints`	`withForceStreamableEnabled()`

Inherited methods

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

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

Public constructors

AggregateHints

public AggregateHints()

Creates a new, empty AggregateHints object.

Public methods

self

public @NonNull AggregateHints self(@NonNull InternalOptions options)

withForceStreamableEnabled

public final @NonNull AggregateHints withForceStreamableEnabled()