ChangeStreamOperationTResult Class |
A change stream operation.
Inheritance HierarchyNamespace: MongoDB.Driver.Core.Operations
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.18.0+554c799eb1ec8dd732f16c739387f6664df1ba7a
Syntaxpublic class ChangeStreamOperation<TResult> : IChangeStreamOperation<TResult>, IReadOperation<IChangeStreamCursor<TResult>>
Type Parameters
- TResult
- The type of the result values.
The ChangeStreamOperationTResult type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ChangeStreamOperationTResult(IEnumerableBsonDocument, IBsonSerializerTResult, MessageEncoderSettings) |
Initializes a new instance of the ChangeStreamOperationTResult class.
|
| ChangeStreamOperationTResult(CollectionNamespace, IEnumerableBsonDocument, IBsonSerializerTResult, MessageEncoderSettings) |
Initializes a new instance of the ChangeStreamOperationTResult class.
|
| ChangeStreamOperationTResult(DatabaseNamespace, IEnumerableBsonDocument, IBsonSerializerTResult, MessageEncoderSettings) |
Initializes a new instance of the ChangeStreamOperationTResult class.
|
Properties| Name | Description | |
|---|---|---|
 | BatchSize |
Gets or sets the size of the batch.
|
| Collation |
Gets or sets the collation.
|
| CollectionNamespace |
Gets the collection namespace.
|
| Comment |
Gets or sets the comment.
|
| DatabaseNamespace |
Gets the database namespace.
|
| FullDocument |
Gets or sets the full document option.
|
| FullDocumentBeforeChange |
Gets or sets the full document before change option.
|
| MaxAwaitTime |
Gets or sets the maximum await time.
|
| MessageEncoderSettings |
Gets the message encoder settings.
|
| Pipeline |
Gets the pipeline.
|
| ReadConcern |
Gets or sets the read concern.
|
| ResultSerializer |
Gets the result serializer.
|
| ResumeAfter |
Gets or sets the resume after value.
|
| RetryRequested |
Gets or sets a value indicating whether to retry.
|
| ShowExpandedEvents |
Gets or sets whether the change stream should show expanded events (MongoDB 6.0 and later).
|
| StartAfter |
Gets or sets the start after value.
|
| StartAtOperationTime |
Gets or sets the start at operation time.
|
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Execute |
Executes the operation.
|
| ExecuteAsync |
Executes the operation.
|
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Resume |
Resumes the operation after a resume token.
|
| ResumeAsync |
Resumes the operation after a resume token.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | ExecuteIChangeStreamCursorTResult |
Executes a read operation using a channel source.
(Defined by OperationExtensionMethods.) |
| ExecuteAsyncIChangeStreamCursorTResult |
Executes a read operation using a channel source.
(Defined by OperationExtensionMethods.) |
| ToBson |
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.) |
| ToBsonDocument |
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.) |
| ToJson |
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.) |
See Also