Module spring.data.mongodb

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

Class ChangeStreamRequest.ChangeStreamRequestOptions

java.lang.Object

org.springframework.data.mongodb.core.messaging.ChangeStreamRequest.ChangeStreamRequestOptions

All Implemented Interfaces:

SubscriptionRequest.RequestOptions

Enclosing class:

ChangeStreamRequest<T>

public static class ChangeStreamRequest.ChangeStreamRequestOptions
extends Object
implements SubscriptionRequest.RequestOptions

SubscriptionRequest.RequestOptions implementation specific to a ChangeStreamRequest.

Since:

2.1

Author:

Christoph Strobl

Constructor Summary

Constructors

Constructor	Description
ChangeStreamRequestOptions(String databaseName, String collectionName, Duration maxAwaitTime, ChangeStreamOptions options)	Create new ChangeStreamRequest.ChangeStreamRequestOptions.
ChangeStreamRequestOptions(String databaseName, String collectionName, ChangeStreamOptions options)	Create new ChangeStreamRequest.ChangeStreamRequestOptions.

Method Summary

Modifier and Type	Method	Description
ChangeStreamOptions	getChangeStreamOptions()	Get the ChangeStreamOptions defined.
String	getCollectionName()	Get the collection name.
String	getDatabaseName()	Get the database name of the db.
Duration	maxAwaitTime()	Get the maximum wait time (the time till the next Document is emitted) to apply when reading from the collection.
static ChangeStreamRequest.ChangeStreamRequestOptions	of(SubscriptionRequest.RequestOptions options)

Methods inherited from class java.lang.Object

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

Constructor Details

ChangeStreamRequestOptions

public ChangeStreamRequestOptions(@Nullable
 String databaseName,
 @Nullable
 String collectionName,
 ChangeStreamOptions options)

Create new ChangeStreamRequest.ChangeStreamRequestOptions.

Parameters:

databaseName - can be null.

collectionName - can be null.

options - must not be null.

ChangeStreamRequestOptions

public ChangeStreamRequestOptions(@Nullable
 String databaseName,
 @Nullable
 String collectionName,
 @Nullable
 Duration maxAwaitTime,
 ChangeStreamOptions options)

Create new ChangeStreamRequest.ChangeStreamRequestOptions.

Parameters:

databaseName - can be null.

collectionName - can be null.

maxAwaitTime - can be null.

options - must not be null.

Since:

3.0

Method Details

of

public static ChangeStreamRequest.ChangeStreamRequestOptions of(SubscriptionRequest.RequestOptions options)

getChangeStreamOptions

public ChangeStreamOptions getChangeStreamOptions()

Get the ChangeStreamOptions defined.

Returns:

never null.

getCollectionName

public String getCollectionName()

Description copied from interface: SubscriptionRequest.RequestOptions

Get the collection name.

Specified by:

getCollectionName in interface SubscriptionRequest.RequestOptions

Returns:

the name of the collection to subscribe to. Can be null.

getDatabaseName

public String getDatabaseName()

Description copied from interface: SubscriptionRequest.RequestOptions

Get the database name of the db.

Specified by:

getDatabaseName in interface SubscriptionRequest.RequestOptions

Returns:

the name of the database to subscribe to. Can be null in which case the default database is used.

maxAwaitTime

public Duration maxAwaitTime()

Description copied from interface: SubscriptionRequest.RequestOptions

Get the maximum wait time (the time till the next Document is emitted) to apply when reading from the collection.

Specified by:

maxAwaitTime in interface SubscriptionRequest.RequestOptions

Returns:

never null. Duration.ZERO by default.