Package org.springframework.data.mongodb.core.messaging

Class ChangeStreamRequest.ChangeStreamRequestBuilder<T>

java.lang.Object

org.springframework.data.mongodb.core.messaging.ChangeStreamRequest.ChangeStreamRequestBuilder<T>

Enclosing class:

ChangeStreamRequest<T>

public static class ChangeStreamRequest.ChangeStreamRequestBuilder<T>
extends Object

Builder for creating ChangeStreamRequest.

Since:

2.1

Author:

Christoph Strobl

See Also:

• ChangeStreamOptions

Method Summary

Modifier and Type	Method	Description
ChangeStreamRequest<T>	build()
ChangeStreamRequest.ChangeStreamRequestBuilder<T>	collation(Collation collation)	Set the collation to use.
ChangeStreamRequest.ChangeStreamRequestBuilder<T>	collection(String collectionName)	Set the name of the MongoCollection to listen to.
ChangeStreamRequest.ChangeStreamRequestBuilder<T>	database(String databaseName)	Set the name of the MongoDatabase to listen to.
ChangeStreamRequest.ChangeStreamRequestBuilder<T>	filter(org.bson.Document... pipeline)	Set the plain filter chain to apply.
ChangeStreamRequest.ChangeStreamRequestBuilder<T>	filter(Aggregation aggregation)	Set the filter to apply.
ChangeStreamRequest.ChangeStreamRequestBuilder<T>	fullDocumentBeforeChangeLookup(com.mongodb.client.model.changestream.FullDocumentBeforeChange lookup)	Set the FullDocumentBeforeChange lookup to the given value.
ChangeStreamRequest.ChangeStreamRequestBuilder<T>	fullDocumentLookup(com.mongodb.client.model.changestream.FullDocument lookup)	Set the FullDocument lookup to FullDocument.UPDATE_LOOKUP.
ChangeStreamRequest.ChangeStreamRequestBuilder<T>	maxAwaitTime(Duration timeout)	Set the cursors maximum wait time on the server (for a new Document to be emitted).
ChangeStreamRequest.ChangeStreamRequestBuilder<T>	publishTo(MessageListener<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>,? super T> messageListener)	Set the MessageListener event messages will be published to.
ChangeStreamRequest.ChangeStreamRequestBuilder<T>	resumeAfter(org.bson.BsonValue resumeToken)	Set the resume token after which to continue emitting notifications.
ChangeStreamRequest.ChangeStreamRequestBuilder<T>	resumeAt(Instant clusterTime)	Set the cluster time at which to resume listening.
ChangeStreamRequest.ChangeStreamRequestBuilder<T>	resumeToken(org.bson.BsonValue resumeToken)	Set the resume token (typically a BsonDocument containing a binary token) after which to start with listening.
ChangeStreamRequest.ChangeStreamRequestBuilder<T>	startAfter(org.bson.BsonValue resumeToken)	Set the resume token after which to start emitting notifications.

Methods inherited from class java.lang.Object

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

Method Details

database

public ChangeStreamRequest.ChangeStreamRequestBuilder<T> database(String databaseName)

Set the name of the MongoDatabase to listen to.

Parameters:

databaseName - must not be null nor empty.

Returns:

this.

collection

public ChangeStreamRequest.ChangeStreamRequestBuilder<T> collection(String collectionName)

Set the name of the MongoCollection to listen to.

Parameters:

collectionName - must not be null nor empty.

Returns:

this.

publishTo

public ChangeStreamRequest.ChangeStreamRequestBuilder<T> publishTo(MessageListener<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>,? super T> messageListener)

Set the MessageListener event messages will be published to.

Parameters:

messageListener - must not be null.

Returns:

this.

filter

public ChangeStreamRequest.ChangeStreamRequestBuilder<T> filter(Aggregation aggregation)

Set the filter to apply.
Fields on aggregation expression root level are prefixed to map to fields contained in fullDocument. However operationType, ns, documentKey and fullDocument are reserved words that will be omitted, and therefore taken as given, during the mapping procedure. You may want to have a look at the structure of Change Events.
Use TypedAggregation to ensure filter expressions are mapped to domain type fields.

Parameters:

aggregation - the Aggregation pipeline to apply for filtering events. Must not be null.

Returns:

this.

See Also:

• ChangeStreamOptions.getFilter()
• ChangeStreamOptions.ChangeStreamOptionsBuilder.filter(Aggregation)

filter

public ChangeStreamRequest.ChangeStreamRequestBuilder<T> filter(org.bson.Document... pipeline)

Set the plain filter chain to apply.

Parameters:

pipeline - must not be null nor contain null values.

Returns:

this.

See Also:

• ChangeStreamOptions.getFilter()

collation

public ChangeStreamRequest.ChangeStreamRequestBuilder<T> collation(Collation collation)

Set the collation to use.

Parameters:

collation - must not be null nor empty.

Returns:

this.

See Also:

• ChangeStreamOptions.getCollation()
• ChangeStreamOptions.ChangeStreamOptionsBuilder.collation(Collation)

resumeToken

public ChangeStreamRequest.ChangeStreamRequestBuilder<T> resumeToken(org.bson.BsonValue resumeToken)

Set the resume token (typically a BsonDocument containing a binary token) after which to start with listening.

Parameters:

resumeToken - must not be null.

Returns:

this.

See Also:

• ChangeStreamOptions.getResumeToken()
• ChangeStreamOptions.ChangeStreamOptionsBuilder.resumeToken(org.bson.BsonValue)

resumeAt

public ChangeStreamRequest.ChangeStreamRequestBuilder<T> resumeAt(Instant clusterTime)

Set the cluster time at which to resume listening.

Parameters:

clusterTime - must not be null.

Returns:

this.

See Also:

• ChangeStreamOptions.getResumeTimestamp()
• ChangeStreamOptions.ChangeStreamOptionsBuilder.resumeAt(java.time.Instant)

resumeAfter

public ChangeStreamRequest.ChangeStreamRequestBuilder<T> resumeAfter(org.bson.BsonValue resumeToken)

Set the resume token after which to continue emitting notifications.

Parameters:

resumeToken - must not be null.

Returns:

this.

Since:

2.2

startAfter

public ChangeStreamRequest.ChangeStreamRequestBuilder<T> startAfter(org.bson.BsonValue resumeToken)

Set the resume token after which to start emitting notifications.

Parameters:

resumeToken - must not be null.

Returns:

this.

Since:

2.2

fullDocumentLookup

public ChangeStreamRequest.ChangeStreamRequestBuilder<T> fullDocumentLookup(com.mongodb.client.model.changestream.FullDocument lookup)

Set the FullDocument lookup to FullDocument.UPDATE_LOOKUP.

Returns:

this.

See Also:

• ChangeStreamOptions.getFullDocumentLookup()
• ChangeStreamOptions.ChangeStreamOptionsBuilder.fullDocumentLookup(FullDocument)

fullDocumentBeforeChangeLookup

public ChangeStreamRequest.ChangeStreamRequestBuilder<T> fullDocumentBeforeChangeLookup(com.mongodb.client.model.changestream.FullDocumentBeforeChange lookup)

Set the FullDocumentBeforeChange lookup to the given value.

Returns:

this.

Since:

4.0

See Also:

• ChangeStreamOptions.getFullDocumentBeforeChangeLookup()
• ChangeStreamOptions.ChangeStreamOptionsBuilder.fullDocumentBeforeChangeLookup(FullDocumentBeforeChange)

maxAwaitTime

public ChangeStreamRequest.ChangeStreamRequestBuilder<T> maxAwaitTime(Duration timeout)

Set the cursors maximum wait time on the server (for a new Document to be emitted).

Parameters:

timeout - must not be null.

Since:

3.0

build

public ChangeStreamRequest<T> build()

Returns:

the build ChangeStreamRequest.