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

@Beta
class UnnestOptions : AbstractOptions

kotlin.Any
↳	com.google.firebase.firestore.pipeline.AbstractOptions
	↳	com.google.firebase.firestore.pipeline.UnnestOptions

Summary

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

Public functions
`UnnestOptions`	`withIndexField(@Nonnull indexField: String)` Adds index field to emitted documents

Inherited functions

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

`UnnestOptions`	`adding(newOptions: AbstractOptions<*>)`
`UnnestOptions`	`with(key: String, subSection: AbstractOptions<*>)`
`UnnestOptions`	`with(key: String, value: <Error class: unknown class>)`
`UnnestOptions`	`with(key: String, value: Boolean)` Specify generic `Boolean` option
`UnnestOptions`	`with(key: String, value: Double)` Specify generic `Double` option
`UnnestOptions`	`with(key: String, value: Field)` Specify generic `Field` option
`UnnestOptions`	`with(key: String, value: Long)` Specify generic `Long` option
`UnnestOptions`	`with(key: String, value: RawOptions)` Specify `RawOptions` object
`UnnestOptions`	`with(key: String, value: String)` Specify generic `String` option
`UnnestOptions`	`with(key: String, vararg values: String)`

Public constructors

UnnestOptions

UnnestOptions()

Creates a new, empty UnnestOptions object.

Public functions

withIndexField

fun withIndexField(@Nonnull indexField: String): UnnestOptions

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 indexField: String`	The field name of index field.

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