com.google.cloud.firestore

Class TransactionOptions

java.lang.Object

com.google.cloud.firestore.TransactionOptions

public final class TransactionOptions
extends Object

Options specifying the behavior of Firestore Transactions.

Method Summary

Modifier and Type	Method and Description
static TransactionOptions	create() Create a default set of options suitable for most use cases.
static TransactionOptions	create(Executor executor) Create a default set of options with a custom executor.
static TransactionOptions	create(Executor executor, int numberOfAttempts) Create a default set of options with a custom executor and a custom number of retry attempts.
static TransactionOptions	create(int numberOfAttempts) Create a default set of options with a custom number of retry attempts.
Executor	getExecutor()
int	getNumberOfAttempts()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getNumberOfAttempts

public int getNumberOfAttempts()

getExecutor

@Nullable
public Executor getExecutor()

create

@Nonnull
public static TransactionOptions create()

Create a default set of options suitable for most use cases. Transactions will be attempted 5 times.

Returns:

The TransactionOptions object.

create

@Nonnull
public static TransactionOptions create(int numberOfAttempts)

Create a default set of options with a custom number of retry attempts.

Parameters:

numberOfAttempts - The number of execution attempts.

Returns:

The TransactionOptions object.

create

@Nonnull
public static TransactionOptions create(@Nonnull
                                                 Executor executor)

Create a default set of options with a custom executor.

Parameters:

executor - The executor to run the user callback code on.

Returns:

The TransactionOptions object.

create

@Nonnull
public static TransactionOptions create(@Nonnull
                                                 Executor executor,
                                                 int numberOfAttempts)

Create a default set of options with a custom executor and a custom number of retry attempts.

Parameters:

executor - The executor to run the user callback code on.

numberOfAttempts - The number of execution attempts.

Returns:

The TransactionOptions object.