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.

CollectionGroupOptions

public final class CollectionGroupOptions extends AbstractOptions

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

Summary

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

Public methods
`@NonNull CollectionGroupOptions`	`self(@NonNull InternalOptions options)`
`final @NonNull CollectionGroupOptions`	`withHints(@NonNull CollectionHints hints)` Specifies query hints for the collection group source.

Inherited methods

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

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

Public constructors

CollectionGroupOptions

public CollectionGroupOptions()

Creates a new, empty CollectionGroupOptions object.

Public methods

self

public @NonNull CollectionGroupOptions self(@NonNull InternalOptions options)

withHints

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

Specifies query hints for the collection group source.

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

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