Pipeline.ExecuteOptions

class Pipeline.ExecuteOptions : AbstractOptions


Summary

Public constructors

Public functions

Pipeline.ExecuteOptions

Sets whether the pipeline is executed atomically.

Pipeline.ExecuteOptions

Inherited functions

From com.google.firebase.firestore.pipeline.AbstractOptions
Pipeline.ExecuteOptions
adding(newOptions: AbstractOptions<*>)
Pipeline.ExecuteOptions
with(key: String, subSection: AbstractOptions<*>)
Pipeline.ExecuteOptions
Pipeline.ExecuteOptions
with(key: String, value: Boolean)

Specify generic Boolean option

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

Specify generic Double option

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

Specify generic Field option

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

Specify generic Long option

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

Specify RawOptions object

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

Specify generic String option

Pipeline.ExecuteOptions
with(key: String, vararg values: String)

Public constructors

ExecuteOptions

ExecuteOptions()

Public functions

withAtomic

fun withAtomic(atomic: Boolean): Pipeline.ExecuteOptions

Sets whether the pipeline is executed atomically.

When true, the pipeline runs in a single read-write transaction that is committed automatically after the pipeline has executed, so either all of its writes (from insert, upsert, update and delete stages) are applied or none are. The default is false.

Parameters
atomic: Boolean

Whether to execute the pipeline atomically.

Returns
Pipeline.ExecuteOptions

A new ExecuteOptions with the atomic setting applied.