IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

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`	`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, @NonNull InternalOptions value)`
`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

withIndexMode

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

Pipeline.ExecuteOptions

Summary

Nested types

Public constructors

Public methods

Inherited methods

Public constructors

ExecuteOptions

Public methods

withIndexMode