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.

CollectionSourceOptions

public final class CollectionSourceOptions extends AbstractOptions

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

Summary

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

Public methods
`final @NonNull CollectionSourceOptions`	`withHints(@NonNull CollectionHints hints)` Specifies query hints for the collection source.

Inherited methods

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

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

Public constructors

CollectionSourceOptions

public CollectionSourceOptions()

Creates a new, empty CollectionSourceOptions object.

Public methods

withHints

public final @NonNull CollectionSourceOptions withHints(@NonNull CollectionHints hints)

Specifies query hints for the collection source.

Parameters
`@NonNull CollectionHints hints`	The hints to apply to the collection source.

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