ChangeStreamOperation (mongo-java-driver 3.6.0 API)

java.lang.Object
- com.mongodb.operation.ChangeStreamOperation<T>

Type Parameters:

T - the operations result type.

All Implemented Interfaces:

AsyncReadOperation<AsyncBatchCursor<T>>, ReadOperation<BatchCursor<T>>
```
public class ChangeStreamOperation<T>
extends java.lang.Object
implements AsyncReadOperation<AsyncBatchCursor<T>>, ReadOperation<BatchCursor<T>>
```
An operation that executes an $changeStream aggregation.

Since:

3.6

MongoDB documentation

Aggregation

Since server release

2.6

Constructor Summary

Constructors
Constructor and Description
`ChangeStreamOperation(MongoNamespace namespace, FullDocument fullDocument, java.util.List<BsonDocument> pipeline, Decoder<T> decoder)` Construct a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ChangeStreamOperation<T>`	`batchSize(java.lang.Integer batchSize)` Sets the number of documents to return per batch.
`ChangeStreamOperation<T>`	`collation(Collation collation)` Sets the collation options
`BatchCursor<T>`	`execute(ReadBinding binding)` General execute which can return anything of type T
`void`	`executeAsync(AsyncReadBinding binding, SingleResultCallback<AsyncBatchCursor<T>> callback)` General execute which can return anything of type T
`java.lang.Integer`	`getBatchSize()` Gets the number of documents to return per batch.
`Collation`	`getCollation()` Returns the collation options
`Decoder<T>`	`getDecoder()`
`FullDocument`	`getFullDocument()` Returns the fullDocument value, in 3.6
`long`	`getMaxAwaitTime(java.util.concurrent.TimeUnit timeUnit)` The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.
`MongoNamespace`	`getNamespace()`
`java.util.List<BsonDocument>`	`getPipeline()` Gets the aggregation pipeline.
`ReadConcern`	`getReadConcern()` Gets the read concern
`BsonDocument`	`getResumeToken()` Returns the logical starting point for the new change stream.
`ChangeStreamOperation<T>`	`maxAwaitTime(long maxAwaitTime, java.util.concurrent.TimeUnit timeUnit)` Sets the maximum await execution time on the server for this operation.
`ChangeStreamOperation<T>`	`readConcern(ReadConcern readConcern)` Sets the read concern
`ChangeStreamOperation<T>`	`resumeAfter(BsonDocument resumeToken)` Sets the logical starting point for the new change stream.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ChangeStreamOperation
```
public ChangeStreamOperation(MongoNamespace namespace,
                             FullDocument fullDocument,
                             java.util.List<BsonDocument> pipeline,
                             Decoder<T> decoder)
```
    Construct a new instance.
    
    Parameters:
    
    namespace - the database and collection namespace for the operation.
    
    fullDocument - the fullDocument value
    
    pipeline - the aggregation pipeline.
    
    decoder - the decoder for the result documents.
- Method Detail
  - getNamespace
```
public MongoNamespace getNamespace()
```
    Returns:
    
    the namespace for this operation
  - getDecoder
```
public Decoder<T> getDecoder()
```
    Returns:
    
    the decoder for this operation
  - getFullDocument
```
public FullDocument getFullDocument()
```
    Returns the fullDocument value, in 3.6
    
    Returns:
    
    the fullDocument value
  - getResumeToken
```
public BsonDocument getResumeToken()
```
    Returns the logical starting point for the new change stream.
    A null value represents the server default.
    
    Returns:
    
    the resumeAfter
  - resumeAfter
```
public ChangeStreamOperation<T> resumeAfter(BsonDocument resumeToken)
```
    Sets the logical starting point for the new change stream.
    
    Parameters:
    
    resumeToken - the resumeToken
    
    Returns:
    
    this
  - getPipeline
```
public java.util.List<BsonDocument> getPipeline()
```
    Gets the aggregation pipeline.
    
    Returns:
    
    the pipeline
    
    MongoDB documentation
    
    Aggregation Pipeline
  - getBatchSize
```
public java.lang.Integer getBatchSize()
```
    Gets the number of documents to return per batch. Default to 0, which indicates that the server chooses an appropriate batch size.
    
    Returns:
    
    the batch size, which may be null
    
    MongoDB documentation
    
    Batch Size
  - batchSize
```
public ChangeStreamOperation<T> batchSize(java.lang.Integer batchSize)
```
    Sets the number of documents to return per batch.
    
    Parameters:
    
    batchSize - the batch size
    
    Returns:
    
    this
    
    MongoDB documentation
    
    Batch Size
  - getMaxAwaitTime
```
public long getMaxAwaitTime(java.util.concurrent.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 ChangeStreamOperation<T> maxAwaitTime(long maxAwaitTime,
                                             java.util.concurrent.TimeUnit timeUnit)
```
    Sets the maximum await execution time on the server for this operation.
    
    Parameters:
    
    maxAwaitTime - the max await time. A value less than one 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 ChangeStreamOperation<T> readConcern(ReadConcern readConcern)
```
    Sets the read concern
    
    Parameters:
    
    readConcern - the read concern
    
    Returns:
    
    this
    
    MongoDB documentation
    
    Read Concern
  - getCollation
```
public Collation getCollation()
```
    Returns the collation options
    
    Returns:
    
    the collation options
    
    MongoDB documentation
    
    Aggregation
  - collation
```
public ChangeStreamOperation<T> collation(Collation collation)
```
    Sets the collation options
    A null value represents the server default.
    
    Parameters:
    
    collation - the collation options to use
    
    Returns:
    
    this
    
    MongoDB documentation
    
    Aggregation
  - execute
```
public BatchCursor<T> execute(ReadBinding binding)
```
    Description copied from interface: ReadOperation
    
    General execute which can return anything of type T
    
    Specified by:
    
    execute in interface ReadOperation<BatchCursor<T>>
    
    Parameters:
    
    binding - the binding to execute in the context of
    
    Returns:
    
    T, the result of the execution
  - executeAsync
```
public void executeAsync(AsyncReadBinding binding,
                         SingleResultCallback<AsyncBatchCursor<T>> callback)
```
    Description copied from interface: AsyncReadOperation
    
    General execute which can return anything of type T
    
    Specified by:
    
    executeAsync in interface AsyncReadOperation<AsyncBatchCursor<T>>
    
    Parameters:
    
    binding - the binding to execute in the context of
    
    callback - the callback to be called when the operation has been executed

Class ChangeStreamOperation<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ChangeStreamOperation

Method Detail

getNamespace

getDecoder

getFullDocument

getResumeToken

resumeAfter

getPipeline

getBatchSize

batchSize

getMaxAwaitTime

maxAwaitTime

getReadConcern

readConcern

getCollation

collation

execute

executeAsync