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

Interface SubscriptionRequest.RequestOptions

All Known Implementing Classes:

ChangeStreamRequest.ChangeStreamRequestOptions, TailableCursorRequest.TailableCursorRequestOptions

Enclosing interface:

SubscriptionRequest<S,T,O extends SubscriptionRequest.RequestOptions>

public static interface SubscriptionRequest.RequestOptions

Options for specifying the behaviour of the SubscriptionRequest.

Since:

2.1

Author:

Christoph Strobl

Method Summary

Modifier and Type	Method	Description
String	getCollectionName()	Get the collection name.
default String	getDatabaseName()	Get the database name of the db.
static SubscriptionRequest.RequestOptions	justCollection(String collection)	Create options with the provided collection.
static SubscriptionRequest.RequestOptions	justDatabase(String database)	Create options with the provided database.
default Duration	maxAwaitTime()	Get the maximum wait time (the time till the next Document is emitted) to apply when reading from the collection.
static SubscriptionRequest.RequestOptions	none()	Create empty options.
static SubscriptionRequest.RequestOptions	of(String database, String collection)	Create options with the provided database and collection.

Method Details

getDatabaseName

@Nullable
default String getDatabaseName()

Get the database name of the db.

Returns:

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

getCollectionName

@Nullable
String getCollectionName()

Get the collection name.

Returns:

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

maxAwaitTime

default Duration maxAwaitTime()

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

Returns:

never null. Duration.ZERO by default.

Since:

3.0

none

static SubscriptionRequest.RequestOptions none()

Create empty options.

Returns:

new instance of empty SubscriptionRequest.RequestOptions.

justDatabase

static SubscriptionRequest.RequestOptions justDatabase(String database)

Create options with the provided database.

Parameters:

database - must not be null.

Returns:

new instance of empty SubscriptionRequest.RequestOptions.

justCollection

static SubscriptionRequest.RequestOptions justCollection(String collection)

Create options with the provided collection.

Parameters:

collection - must not be null.

Returns:

new instance of empty SubscriptionRequest.RequestOptions.

of

static SubscriptionRequest.RequestOptions of(String database,
 String collection)

Create options with the provided database and collection.

Parameters:

database - must not be null.

collection - must not be null.

Returns:

new instance of empty SubscriptionRequest.RequestOptions.