com.mongodb

Class ClientSessionOptions

java.lang.Object

com.mongodb.ClientSessionOptions

@Immutable
public final class ClientSessionOptions
extends Object

The options to apply to a ClientSession.

Since:

3.6

See Also:

ClientSession, MongoClient.startSession(ClientSessionOptions)

Since server release

3.6

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientSessionOptions.Builder A builder for instances of ClientSession

Method Summary

Modifier and Type	Method and Description
static ClientSessionOptions.Builder	builder() Gets an instance of a builder
BsonDocument	getInitialClusterTime() Gets the initial cluster time to apply to the client session
BsonTimestamp	getInitialOperationTime() Gets the initial operation time to apply to the client session
Boolean	isCausallyConsistent() Whether operations using the session should causally consistent with each other.

Methods inherited from class java.lang.Object

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

Method Detail

isCausallyConsistent

public Boolean isCausallyConsistent()

Whether operations using the session should causally consistent with each other.

Returns:

whether operations using the session should be causally consistent. A null value indicates to use the the global default, which is currently true.

getInitialClusterTime

public BsonDocument getInitialClusterTime()

Gets the initial cluster time to apply to the client session

Returns:

the initial cluster time, which may be null

getInitialOperationTime

public BsonTimestamp getInitialOperationTime()

Gets the initial operation time to apply to the client session

Returns:

the initial operation time, which may be null

builder

public static ClientSessionOptions.Builder builder()

Gets an instance of a builder

Returns:

a builder instance