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.

UnnestOptions

public final class UnnestOptions extends AbstractOptions

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

Summary

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

Public methods
`@NonNull UnnestOptions`	`self(@NonNull InternalOptions options)`
`final @NonNull UnnestOptions`	`withIndexField(@Nonnull @NonNull String indexField)` Adds index field to emitted documents

Inherited methods

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

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

Public constructors

UnnestOptions

public UnnestOptions()

Creates a new, empty UnnestOptions object.

Public methods

self

public @NonNull UnnestOptions self(@NonNull InternalOptions options)

withIndexField

public final @NonNull UnnestOptions withIndexField(@Nonnull @NonNull String indexField)

Adds index field to emitted documents

A field with name specified in indexField will be added to emitted document. The index is a numeric value that corresponds to array index of the element from input array.

Parameters
`@Nonnull @NonNull String indexField`	The field name of index field.

Returns
`@NonNull UnnestOptions`	A new `UnnestOptions` that includes the specified index field.