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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChangeStreamOptions()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ChangeStreamOptions

protected ChangeStreamOptions()

Method Detail

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.

getCollation

public Optional<Collation> getCollation()

Returns:

Optional.empty() if not set.

getResumeTimestamp

public Optional<Instant> getResumeTimestamp()

Returns:

Optional.empty() if not set.

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 your're done.

Returns:

new instance of ChangeStreamOptions.ChangeStreamOptionsBuilder.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object