Package 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.

A transaction in Firestore can be either read-write or read-only.

The default set of options is a read-write transaction with a maximum number of 5 attempts. This attempt count can be customized via the TransactionOptions.ReadWriteOptionsBuilder.setNumberOfAttempts(int) method. A new instance of a builder can be created by calling createReadWriteOptionsBuilder().

A read-only transaction can be configured via the TransactionOptions.ReadOnlyOptionsBuilder class. A new instance can be created by calling createReadOnlyOptionsBuilder().

See Also:

• TransactionOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TransactionOptions.Builder<B extends TransactionOptions.Builder<B>>
static final class	TransactionOptions.ReadOnlyOptionsBuilder	A typesafe builder class representing those options that are applicable when configuring a transaction to be read-only.
static final class	TransactionOptions.ReadWriteOptionsBuilder	A typesafe builder class representing those options that are applicable when configuring a transaction to be read-write.
static enum	TransactionOptions.TransactionOptionsType

Method Summary

Modifier and Type	Method	Description
static TransactionOptions	create()	Create a default set of options suitable for most use cases.
static TransactionOptions	create(int numberOfAttempts)	Deprecated. as of 2.0.0, replaced by TransactionOptions.ReadWriteOptionsBuilder.setNumberOfAttempts(int)
static TransactionOptions	create(Executor executor)	Deprecated. as of 2.0.0, replaced by TransactionOptions.Builder.setExecutor(Executor)
static TransactionOptions	create(Executor executor, int numberOfAttempts)	Deprecated. as of 2.0.0, replaced by TransactionOptions.Builder.setExecutor(Executor) and TransactionOptions.ReadWriteOptionsBuilder.setNumberOfAttempts(int)
static TransactionOptions.ReadOnlyOptionsBuilder	createReadOnlyOptionsBuilder()
static TransactionOptions.ReadWriteOptionsBuilder	createReadWriteOptionsBuilder()
Executor	getExecutor()
int	getNumberOfAttempts()	Returns the maximum number of times a transaction will be attempted before resulting in an error.
com.google.protobuf.Timestamp	getReadTime()	A Timestamp specifying the time documents are to be read at.
TransactionOptions.TransactionOptionsType	getType()	A type flag indicating the type of transaction represented.

Methods inherited from class java.lang.Object

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

Method Details

getNumberOfAttempts

public int getNumberOfAttempts()

Returns the maximum number of times a transaction will be attempted before resulting in an error.

Returns:

The max number of attempts to try and commit the transaction.

getExecutor

@Nullable
public Executor getExecutor()

Returns:

Executor to be used to run user callbacks on

getType

@Nonnull
public TransactionOptions.TransactionOptionsType getType()

A type flag indicating the type of transaction represented.

Returns:

The type of transaction this represents. Either read-only or read-write.

getReadTime

@Nullable
public com.google.protobuf.Timestamp getReadTime()

A Timestamp specifying the time documents are to be read at. If null, the server will read documents at the most up to date available. If non-null, the specified Timestamp may not be more than 60 minutes in the past (evaluated when the request is processed by the server).

Returns:

The specific time to read documents at. A null value means reading the most up to date data.

create

@Nonnull
public static TransactionOptions create()

Create a default set of options suitable for most use cases. Transactions will be opened as ReadWrite transactions and attempted up to 5 times.

Returns:

The TransactionOptions object.

See Also:

• createReadWriteOptionsBuilder()

create

@Nonnull
@Deprecated
public static TransactionOptions create(int numberOfAttempts)

Deprecated.

as of 2.0.0, replaced by TransactionOptions.ReadWriteOptionsBuilder.setNumberOfAttempts(int)

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

Parameters:

numberOfAttempts - The number of execution attempts.

Returns:

The TransactionOptions object.

See Also:

• createReadWriteOptionsBuilder()

create

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

Deprecated.

as of 2.0.0, replaced by TransactionOptions.Builder.setExecutor(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.

See Also:

• createReadWriteOptionsBuilder()

create

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

Deprecated.

as of 2.0.0, replaced by TransactionOptions.Builder.setExecutor(Executor) and TransactionOptions.ReadWriteOptionsBuilder.setNumberOfAttempts(int)

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.

See Also:

• createReadWriteOptionsBuilder()

createReadWriteOptionsBuilder

@Nonnull
public static TransactionOptions.ReadWriteOptionsBuilder createReadWriteOptionsBuilder()

Returns:

a new Builder with default values applicable to configuring options for a read-write transaction.

createReadOnlyOptionsBuilder

@Nonnull
public static TransactionOptions.ReadOnlyOptionsBuilder createReadOnlyOptionsBuilder()

Returns:

a new Builder with default values applicable to configuring options for a read-only transaction.