com.mongodb.reactivestreams.client.ChangeStreamPublisher Maven / Gradle / Ivy
Show all versions of mongodb-driver-reactivestreams Show documentation
/*
* Copyright 2008-present MongoDB, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package com.mongodb.reactivestreams.client;
import com.mongodb.client.model.Collation;
import com.mongodb.client.model.changestream.ChangeStreamDocument;
import com.mongodb.client.model.changestream.FullDocument;
import com.mongodb.client.model.changestream.FullDocumentBeforeChange;
import com.mongodb.lang.Nullable;
import org.bson.BsonDocument;
import org.bson.BsonTimestamp;
import org.bson.BsonValue;
import org.reactivestreams.Publisher;
import java.util.concurrent.TimeUnit;
/**
* Iterable for change streams.
*
* @param The type of the result.
* @mongodb.server.release 3.6
* @since 1.6
*/
public interface ChangeStreamPublisher extends Publisher> {
/**
* Sets the fullDocument value.
*
* @param fullDocument the fullDocument
* @return this
*/
ChangeStreamPublisher fullDocument(FullDocument fullDocument);
/**
* Sets the fullDocumentBeforeChange value.
*
* @param fullDocumentBeforeChange the fullDocumentBeforeChange
* @return this
* @since 4.7
* @mongodb.server.release 6.0
*/
ChangeStreamPublisher fullDocumentBeforeChange(FullDocumentBeforeChange fullDocumentBeforeChange);
/**
* Sets the logical starting point for the new change stream.
*
* @param resumeToken the resume token
* @return this
*/
ChangeStreamPublisher resumeAfter(BsonDocument resumeToken);
/**
* The change stream will only provide changes that occurred after the specified timestamp.
*
* Any command run against the server will return an operation time that can be used here.
* The default value is an operation time obtained from the server before the change stream was created.
*
* @param startAtOperationTime the start at operation time
* @since 1.9
* @return this
* @mongodb.server.release 4.0
* @mongodb.driver.manual reference/method/db.runCommand/
*/
ChangeStreamPublisher startAtOperationTime(BsonTimestamp startAtOperationTime);
/**
* Similar to {@code resumeAfter}, this option takes a resume token and starts a
* new change stream returning the first notification after the token.
*
* This will allow users to watch collections that have been dropped and recreated
* or newly renamed collections without missing any notifications.
*
* Note: The server will report an error if both {@code startAfter} and {@code resumeAfter} are specified.
*
* @param startAfter the startAfter resumeToken
* @return this
* @since 1.12
* @mongodb.server.release 4.2
* @mongodb.driver.manual changeStreams/#change-stream-start-after
*/
ChangeStreamPublisher startAfter(BsonDocument startAfter);
/**
* Sets the maximum await execution time on the server for this operation.
*
* @param maxAwaitTime the max await time. A zero value will be ignored, and indicates that the driver should respect the server's
* default value
* @param timeUnit the time unit, which may not be null
* @return this
*/
ChangeStreamPublisher maxAwaitTime(long maxAwaitTime, TimeUnit timeUnit);
/**
* Sets the collation options
*
* A null value represents the server default.
* @param collation the collation options to use
* @return this
*/
ChangeStreamPublisher collation(@Nullable Collation collation);
/**
* Returns a {@code MongoIterable} containing the results of the change stream based on the document class provided.
*
* @param clazz the class to use for the raw result.
* @param the result type
* @return the new Mongo Iterable
*/
Publisher withDocumentClass(Class clazz);
/**
* Sets the number of documents to return per batch.
*
* Overrides the {@link org.reactivestreams.Subscription#request(long)} value for setting the batch size, allowing for fine-grained
* control over the underlying cursor.
*
* @param batchSize the batch size
* @return this
* @since 1.8
* @mongodb.driver.manual reference/method/cursor.batchSize/#cursor.batchSize Batch Size
*/
ChangeStreamPublisher batchSize(int batchSize);
/**
* Helper to return a publisher limited to the first result.
*
* @return a Publisher which will contain a single item.
* @since 1.8
*/
Publisher> first();
/**
* Sets the comment for this operation. A null value means no comment is set.
*
* @param comment the comment
* @return this
* @since 4.6
* @mongodb.server.release 3.6
*/
ChangeStreamPublisher comment(@Nullable String comment);
/**
* Sets the comment for this operation. A null value means no comment is set.
*
* The comment can be any valid BSON type for server versions 4.4 and above.
* Server versions between 3.6 and 4.2 only support string as comment,
* and providing a non-string type will result in a server-side error.
*
* @param comment the comment
* @return this
* @since 4.6
* @mongodb.server.release 3.6
*/
ChangeStreamPublisher comment(@Nullable BsonValue comment);
/**
* Sets whether to include expanded change stream events, which are:
* createIndexes, dropIndexes, modify, create, shardCollection,
* reshardCollection, refineCollectionShardKey. False by default.
*
* @param showExpandedEvents true to include expanded events
* @return this
* @since 4.7
* @mongodb.server.release 6.0
*/
ChangeStreamPublisher showExpandedEvents(boolean showExpandedEvents);
}