firebase-firestore/com.google.firebase.firestore.pipeline/UnnestOptions

UnnestOptions

class UnnestOptions : AbstractOptions<UnnestOptions> (source)

The options of Pipeline.unnest.

Constructors

UnnestOptions

constructor()

No options.

Functions

with

fun with(key: String, value: Field): UnnestOptions

A copy with the option key set to a reference to the field value. The JS SDK sends a field reference only as a nearest-neighbour search's distance field or an unnest's index field; on JS and wasmJs any other fails the execution.

fun with(key: String, value: RawOptions): UnnestOptions

A copy with the option key set to the options value.

fun with(key: String, value: Boolean): UnnestOptions

fun with(key: String, value: Double): UnnestOptions

fun with(key: String, value: Long): UnnestOptions

fun with(key: String, value: String): UnnestOptions

A copy with the option key set to value.

withIndexField

fun withIndexField(indexField: String): UnnestOptions

A copy writing the index of each element to the field indexField.