Package com.mongodb

Class TransactionOptions.Builder

java.lang.Object

com.mongodb.TransactionOptions.Builder

Enclosing class:

TransactionOptions

public static final class TransactionOptions.Builder
extends Object

The builder for transaction options

Method Summary

Modifier and Type	Method	Description
TransactionOptions	build()	Build the transaction options instance.
TransactionOptions.Builder	maxCommitTime(Long maxCommitTime, TimeUnit timeUnit)	Sets the maximum execution time on the server for the commitTransaction operation.
TransactionOptions.Builder	readConcern(ReadConcern readConcern)	Sets the read concern.
TransactionOptions.Builder	readPreference(ReadPreference readPreference)	Sets the read preference.
TransactionOptions.Builder	writeConcern(WriteConcern writeConcern)	Sets the write concern.

Methods inherited from class java.lang.Object

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

Method Detail

readConcern

public TransactionOptions.Builder readConcern(@Nullable
                                              ReadConcern readConcern)

Sets the read concern.

Parameters:

readConcern - the read concern

Returns:

this

writeConcern

public TransactionOptions.Builder writeConcern(@Nullable
                                               WriteConcern writeConcern)

Sets the write concern.

Parameters:

writeConcern - the write concern, which must be acknowledged

Returns:

this

readPreference

public TransactionOptions.Builder readPreference(@Nullable
                                                 ReadPreference readPreference)

Sets the read preference.

Parameters:

readPreference - the read preference, which currently must be primary. This restriction may be relaxed in future versions.

Returns:

this

maxCommitTime

public TransactionOptions.Builder maxCommitTime(@Nullable
                                                Long maxCommitTime,
                                                TimeUnit timeUnit)

Sets the maximum execution time on the server for the commitTransaction operation.

Parameters:

maxCommitTime - the max commit time, which must be either null or greater than zero, in the given time unit

timeUnit - the time unit, which may not be null

Returns:

this

Since:

3.11

Since server release

4.2

build

public TransactionOptions build()

Build the transaction options instance.

Returns:

The TransactionOptions