com.mongodb

Class DBCollectionChangeStreamOptions

java.lang.Object

com.mongodb.DBCollectionChangeStreamOptions

public final class DBCollectionChangeStreamOptions
extends Object

The options to apply to a change stream operation.

Since:

3.6

Constructor Summary

Constructors

Constructor and Description
DBCollectionChangeStreamOptions() Construct a new instance.

Method Summary

Modifier and Type	Method and Description
DBCollectionChangeStreamOptions	batchSize(Integer batchSize) Sets the batchSize
DBCollectionChangeStreamOptions	collation(Collation collation) Sets the collation
DBCollectionChangeStreamOptions	fullDocument(FullDocument fullDocument) Sets the fullDocument
Integer	getBatchSize() Returns the batchSize
Collation	getCollation() Returns the collation
FullDocument	getFullDocument() Returns the fullDocument
long	getMaxAwaitTime(TimeUnit timeUnit) The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.
ReadConcern	getReadConcern() Gets the read concern
ReadPreference	getReadPreference() Returns the readPreference
DBObject	getResumeToken() Returns the resumeToken
DBCollectionChangeStreamOptions	maxAwaitTime(long maxAwaitTime, TimeUnit timeUnit) Sets the maximum await execution time on the server for this operation.
DBCollectionChangeStreamOptions	readConcern(ReadConcern readConcern) Sets the read concern
DBCollectionChangeStreamOptions	readPreference(ReadPreference readPreference) Sets the readPreference
DBCollectionChangeStreamOptions	resumeToken(DBObject resumeToken) Sets the resumeToken

Methods inherited from class java.lang.Object

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

Constructor Detail

DBCollectionChangeStreamOptions

public DBCollectionChangeStreamOptions()

Construct a new instance.

Method Detail

getBatchSize

public Integer getBatchSize()

Returns the batchSize

Returns:

the batchSize

batchSize

public DBCollectionChangeStreamOptions batchSize(Integer batchSize)

Sets the batchSize

Parameters:

batchSize - the batchSize

Returns:

this

getCollation

public Collation getCollation()

Returns the collation

Returns:

the collation

collation

public DBCollectionChangeStreamOptions collation(Collation collation)

Sets the collation

Parameters:

collation - the collation

Returns:

this

getFullDocument

public FullDocument getFullDocument()

Returns the fullDocument

Returns:

the fullDocument

fullDocument

public DBCollectionChangeStreamOptions fullDocument(FullDocument fullDocument)

Sets the fullDocument

Parameters:

fullDocument - the fullDocument

Returns:

this

getMaxAwaitTime

public long getMaxAwaitTime(TimeUnit timeUnit)

The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. This only applies to a TAILABLE_AWAIT cursor. When the cursor is not a TAILABLE_AWAIT cursor, this option is ignored.

A zero value will be ignored.

Parameters:

timeUnit - the time unit to return the result in

Returns:

the maximum await execution time in the given time unit

MongoDB documentation

Max Time

maxAwaitTime

public DBCollectionChangeStreamOptions maxAwaitTime(long maxAwaitTime,
                                                    TimeUnit timeUnit)

Sets the maximum await execution time on the server for this operation.

Parameters:

maxAwaitTime - the max await time. A zero value will be ignored, and indicates that the driver should respect the server's default value

timeUnit - the time unit, which may not be null

Returns:

this

getReadConcern

public ReadConcern getReadConcern()

Gets the read concern

Returns:

the read concern

MongoDB documentation

Read Concern

readConcern

public DBCollectionChangeStreamOptions readConcern(ReadConcern readConcern)

Sets the read concern

Parameters:

readConcern - the read concern

Returns:

this

MongoDB documentation

Read Concern

getReadPreference

public ReadPreference getReadPreference()

Returns the readPreference

Returns:

the readPreference

readPreference

public DBCollectionChangeStreamOptions readPreference(ReadPreference readPreference)

Sets the readPreference

Parameters:

readPreference - the readPreference

Returns:

this

getResumeToken

public DBObject getResumeToken()

Returns the resumeToken

Returns:

the resumeToken

resumeToken

public DBCollectionChangeStreamOptions resumeToken(DBObject resumeToken)

Sets the resumeToken

Parameters:

resumeToken - the resumeToken

Returns:

this