Module spring.data.mongodb

Package org.springframework.data.mongodb.core

Class ChangeStreamOptions

java.lang.Object

org.springframework.data.mongodb.core.ChangeStreamOptions

public class ChangeStreamOptions
extends Object

Options applicable to MongoDB Change Streams. Intended to be used along with ChangeStreamRequest in a sync world as well ReactiveMongoOperations if you prefer it that way.

Since:

2.1

Author:

Christoph Strobl, Mark Paluch, Myroslav Kosinskyi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChangeStreamOptions.ChangeStreamOptionsBuilder	Builder for creating ChangeStreamOptions.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ChangeStreamOptions()

Method Summary

Modifier and Type	Method	Description
static ChangeStreamOptions.ChangeStreamOptionsBuilder	builder()	Obtain a shiny new ChangeStreamOptions.ChangeStreamOptionsBuilder and start defining options in this fancy fluent way.
static ChangeStreamOptions	empty()
boolean	equals(Object o)
Optional<Collation>	getCollation()
Optional<Object>	getFilter()
Optional<com.mongodb.client.model.changestream.FullDocumentBeforeChange>	getFullDocumentBeforeChangeLookup()
Optional<com.mongodb.client.model.changestream.FullDocument>	getFullDocumentLookup()
Optional<org.bson.BsonTimestamp>	getResumeBsonTimestamp()
Optional<Instant>	getResumeTimestamp()
Optional<org.bson.BsonValue>	getResumeToken()
int	hashCode()
boolean	isResumeAfter()
boolean	isStartAfter()

Methods inherited from class java.lang.Object

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

Constructor Details

ChangeStreamOptions

protected ChangeStreamOptions()

Method Details

getFilter

public Optional<Object> getFilter()

Returns:

Optional.empty() if not set.

getResumeToken

public Optional<org.bson.BsonValue> getResumeToken()

Returns:

Optional.empty() if not set.

getFullDocumentLookup

public Optional<com.mongodb.client.model.changestream.FullDocument> getFullDocumentLookup()

Returns:

Optional.empty() if not set.

getFullDocumentBeforeChangeLookup

public Optional<com.mongodb.client.model.changestream.FullDocumentBeforeChange> getFullDocumentBeforeChangeLookup()

Returns:

Optional.empty() if not set.

Since:

4.0

getCollation

public Optional<Collation> getCollation()

Returns:

Optional.empty() if not set.

getResumeTimestamp

public Optional<Instant> getResumeTimestamp()

Returns:

Optional.empty() if not set.

getResumeBsonTimestamp

public Optional<org.bson.BsonTimestamp> getResumeBsonTimestamp()

Returns:

Optional.empty() if not set.

Since:

2.2

isStartAfter

public boolean isStartAfter()

Returns:

true if the change stream should be started after the token.

Since:

2.2

isResumeAfter

public boolean isResumeAfter()

Returns:

true if the change stream should be resumed after the token.

Since:

2.2

empty

public static ChangeStreamOptions empty()

Returns:

empty ChangeStreamOptions.

builder

public static ChangeStreamOptions.ChangeStreamOptionsBuilder builder()

Obtain a shiny new ChangeStreamOptions.ChangeStreamOptionsBuilder and start defining options in this fancy fluent way. Just don't forget to call build() when done.

Returns:

new instance of ChangeStreamOptions.ChangeStreamOptionsBuilder.

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object