Package 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

MongoDB documentation

Causal Consistency

Since server release

3.6

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ClientSessionOptions.Builder	builder()	Gets an instance of a builder
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

@Nullable
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.

MongoDB documentation

Causal Consistency

builder

public static ClientSessionOptions.Builder builder()

Gets an instance of a builder

Returns:

a builder instance