Pipeline.ExecuteOptions

public final class Pipeline.ExecuteOptions extends AbstractOptions

java.lang.Object
↳	com.google.firebase.firestore.pipeline.AbstractOptions
	↳	com.google.firebase.firestore.Pipeline.ExecuteOptions

---

Summary

Nested types
public final class Pipeline.ExecuteOptions.IndexMode
public static class Pipeline.ExecuteOptions.IndexMode.Companion

Public constructors
ExecuteOptions()

Public methods
final @NonNull Pipeline.ExecuteOptions	withAtomic(boolean atomic) Sets whether the pipeline is executed atomically.
final @NonNull Pipeline.ExecuteOptions	withIndexMode(@NonNull Pipeline.ExecuteOptions.IndexMode indexMode)

Inherited methods

From com.google.firebase.firestore.pipeline.AbstractOptions final @NonNull Pipeline.ExecuteOptions adding(@NonNull AbstractOptions<@NonNull ?> newOptions) final @NonNull Pipeline.ExecuteOptions with(@NonNull String key, @NonNull AbstractOptions<@NonNull ?> subSection) final @NonNull Pipeline.ExecuteOptions with(@NonNull String key, @NonNull <Error class: unknown class> value) final @NonNull Pipeline.ExecuteOptions with(@NonNull String key, boolean value) Specify generic Boolean option final @NonNull Pipeline.ExecuteOptions with(@NonNull String key, double value) Specify generic Double option final @NonNull Pipeline.ExecuteOptions with(@NonNull String key, @NonNull Field value) Specify generic Field option final @NonNull Pipeline.ExecuteOptions with(@NonNull String key, long value) Specify generic Long option final @NonNull Pipeline.ExecuteOptions with(@NonNull String key, @NonNull RawOptions value) Specify RawOptions object final @NonNull Pipeline.ExecuteOptions with(@NonNull String key, @NonNull String value) Specify generic String option final @NonNull Pipeline.ExecuteOptions with(@NonNull String key, @NonNull String values)

Public constructors

ExecuteOptions

public ExecuteOptions()

Public methods

withAtomic

public final @NonNull Pipeline.ExecuteOptions withAtomic(boolean atomic)

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
boolean atomic	Whether to execute the pipeline atomically.

Returns
@NonNull Pipeline.ExecuteOptions	A new ExecuteOptions with the atomic setting applied.

withIndexMode

public final @NonNull Pipeline.ExecuteOptions withIndexMode(@NonNull Pipeline.ExecuteOptions.IndexMode indexMode)