firebase-firestore/com.google.firebase.firestore/Pipeline/ExecuteOptions

ExecuteOptions

class ExecuteOptions : AbstractOptions<Pipeline.ExecuteOptions> (source)

The options of an execution; besides the typed ones, with sets an option by its backend name. The iOS SDK takes only withAtomic: on Apple platforms, executing with any other fails with UnsupportedOperationException.

Constructors

ExecuteOptions

constructor()

No options.

Types

IndexMode

class IndexMode

How the execution uses indexes.

Functions

with

fun with(key: String, value: Field): Pipeline.ExecuteOptions

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): Pipeline.ExecuteOptions

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

fun with(key: String, value: Boolean): Pipeline.ExecuteOptions

fun with(key: String, value: Double): Pipeline.ExecuteOptions

fun with(key: String, value: Long): Pipeline.ExecuteOptions

fun with(key: String, value: String): Pipeline.ExecuteOptions

A copy with the option key set to value.

withAtomic

fun withAtomic(atomic: Boolean): Pipeline.ExecuteOptions

A copy that runs the pipeline's writes atomically, all or none, if atomic.

withIndexMode

fun withIndexMode(indexMode: Pipeline.ExecuteOptions.IndexMode): Pipeline.ExecuteOptions

A copy with the index mode indexMode.