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.

CollectionHints

public final class CollectionHints extends AbstractOptions

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

Summary

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

Public methods
`@NonNull CollectionHints`	`self(@NonNull InternalOptions options)`
`final @NonNull CollectionHints`	`withForceIndex(@NonNull String value)` Forces the query to use a specific index.
`final @NonNull CollectionHints`	`withIgnoreIndexFields(@NonNull String values)` Specifies fields to ignore in the index.

Inherited methods

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

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

Public constructors

CollectionHints

public CollectionHints()

Creates a new, empty CollectionHints object.

Public methods

self

public @NonNull CollectionHints self(@NonNull InternalOptions options)

withForceIndex

public final @NonNull CollectionHints withForceIndex(@NonNull String value)

Forces the query to use a specific index.

Parameters
`@NonNull String value`	The name of the index to force.

Returns
`@NonNull CollectionHints`	A new `CollectionHints` with the specified forced index.

withIgnoreIndexFields

public final @NonNull CollectionHints withIgnoreIndexFields(@NonNull String values)

Specifies fields to ignore in the index.

Parameters
`@NonNull String values`	The names of the fields to ignore in the index.

Returns
`@NonNull CollectionHints`	A new `CollectionHints` with the specified ignored index fields.