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 and Description
ChangeStreamRequestOptions(String databaseName, String collectionName, ChangeStreamOptions options) Create new ChangeStreamRequest.ChangeStreamRequestOptions.

Method Summary

Modifier and Type	Method and Description
ChangeStreamOptions	getChangeStreamOptions() Get the ChangeStreamOptions defined.
String	getCollectionName() Get the collection name.
String	getDatabaseName() Get the database name of the db.
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

Methods inherited from interface org.springframework.data.mongodb.core.messaging.SubscriptionRequest.RequestOptions

justCollection, justDatabase, none, of

Constructor Detail

ChangeStreamRequestOptions

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

Create new ChangeStreamRequest.ChangeStreamRequestOptions.

Parameters:

collectionName - can be null.

options - must not be null.

Method Detail

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.