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

CollectionSourceOptions

class CollectionSourceOptions : AbstractOptions<CollectionSourceOptions> (source)

The options of a collection source. On Apple platforms only the forced index (CollectionHints.withForceIndex) is supported; with any other option, executing the pipeline fails with UnsupportedOperationException.

Constructors

constructor()

No options.

Functions

with

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

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

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

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

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

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

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

A copy with the option key set to value.

withHints

fun withHints(hints: CollectionHints): CollectionSourceOptions

A copy with the index hints added.