Class MongoDbChangeStreamCaptureOptions
Namespace: Cephalon.Data.MongoDB.Configuration
Assembly: Cephalon.Data.MongoDB.dll
Declares one provider-native MongoDB change-stream capture for the active runtime.
public sealed class MongoDbChangeStreamCaptureOptionsInheritance
Section titled “Inheritance”object ← MongoDbChangeStreamCaptureOptions
Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Properties
Section titled “Properties”BatchSize
Section titled “ BatchSize”Gets or sets the optional batch size for each provider-native change-stream batch.
public int? BatchSize { get; set; }Property Value
Section titled “Property Value”int?
ChannelId
Section titled “ ChannelId”Gets or sets the logical outbox channel that receives emitted publications.
public string ChannelId { get; set; }Property Value
Section titled “Property Value”CollectionName
Section titled “ CollectionName”Gets or sets the collection name that the provider-native change stream should watch.
public string CollectionName { get; set; }Property Value
Section titled “Property Value”DatabaseName
Section titled “ DatabaseName”Gets or sets the database name to watch. When omitted, the pack-level database name is used.
public string? DatabaseName { get; set; }Property Value
Section titled “Property Value”Description
Section titled “ Description”Gets or sets the human-readable CDC capture description.
public string Description { get; set; }Property Value
Section titled “Property Value”DisplayName
Section titled “ DisplayName”Gets or sets the operator-facing CDC capture name.
public string DisplayName { get; set; }Property Value
Section titled “Property Value”EventFormat
Section titled “ EventFormat”Gets or sets the operator-facing event format projected on the CDC descriptor.
public string EventFormat { get; set; }Property Value
Section titled “Property Value”FullDocumentMode
Section titled “ FullDocumentMode”Gets or sets the MongoDB full-document mode, such as update-lookup or when-available.
public string FullDocumentMode { get; set; }Property Value
Section titled “Property Value”Gets or sets the stable CDC capture identifier.
public string Id { get; set; }Property Value
Section titled “Property Value”MaxAwaitTimeSeconds
Section titled “ MaxAwaitTimeSeconds”Gets or sets the maximum await time, in seconds, for one provider-native change-stream batch.
public int MaxAwaitTimeSeconds { get; set; }Property Value
Section titled “Property Value”MessageType
Section titled “ MessageType”Gets or sets the logical message type emitted for each captured change event.
public string MessageType { get; set; }Property Value
Section titled “Property Value”Metadata
Section titled “ Metadata”Gets arbitrary operator-facing metadata that should flow through the capture descriptor.
public IDictionary<string, string> Metadata { get; }Property Value
Section titled “Property Value”OutboxId
Section titled “ OutboxId”Gets or sets the outbox identifier that receives emitted publications.
public string OutboxId { get; set; }Property Value
Section titled “Property Value”ResourceIds
Section titled “ ResourceIds”Gets the resource identifiers observed by the capture.
public IList<string> ResourceIds { get; }Property Value
Section titled “Property Value”SourceId
Section titled “ SourceId”Gets or sets the logical source identifier when it should differ from the watched collection path.
public string SourceId { get; set; }Property Value
Section titled “Property Value”SourceModuleId
Section titled “ SourceModuleId”Gets or sets the module identifier that owns the capture surface.
public string SourceModuleId { get; set; }Property Value
Section titled “Property Value”Gets the descriptive tags associated with the capture.
public IList<string> Tags { get; }