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

AbstractOptions

abstract class AbstractOptions<T : AbstractOptions<T>>(source)

The base of the option builders of the pipeline API (stage options, hints and execute options): immutable, each with returns a copy with the option set. Besides the typed options of each builder, with sets an option by name, as the backend knows it.

Inheritors

ExecuteOptions

RawOptions

CollectionSourceOptions

CollectionHints

CollectionGroupOptions

Functions

with

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

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): T

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

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

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

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

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

A copy with the option key set to value.