Class CdcCaptureDescriptor
Namespace: Cephalon.Abstractions.Data
Assembly: Cephalon.Abstractions.dll
Describes one change-data-capture surface contributed to the active runtime.
public sealed class CdcCaptureDescriptorInheritance
Section titled “Inheritance”Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
Section titled “Constructors”CdcCaptureDescriptor(string, string, string, string, string, string, string, string, string, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyDictionary<string, string>?)
Section titled “ CdcCaptureDescriptor(string, string, string, string, string, string, string, string, string, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyDictionary<string, string>?)”Creates a new CDC capture descriptor.
[JsonConstructor]public CdcCaptureDescriptor(string id, string displayName, string description, string sourceModuleId, string provider, string sourceId, string outboxId, string mode = "log-based", string eventFormat = "debezium-envelope", IReadOnlyList<string>? resourceIds = null, IReadOnlyList<string>? tags = null, IReadOnlyDictionary<string, string>? metadata = null)Parameters
Section titled “Parameters”id string
The stable CDC capture identifier.
displayName string
The operator-facing CDC capture name.
description string
The human-readable CDC capture description.
sourceModuleId string
The module identifier that owns the CDC capture.
provider string
The logical provider identifier that supplies the change feed.
sourceId string
The logical source stream, database, or feed identifier.
outboxId string
The outbox identifier that receives captured publications.
mode string
The capture mode such as wal, change-stream, or table-tail.
eventFormat string
The emitted change-event format such as debezium-envelope.
resourceIds IReadOnlyList<string>?
Optional resource identifiers such as tables, collections, or topics observed by the capture.
tags IReadOnlyList<string>?
Optional descriptive tags associated with the CDC capture.
metadata IReadOnlyDictionary<string, string>?
Optional operator-facing metadata associated with the CDC capture.
CdcCaptureDescriptor(string, string, string, string, string, string, string, CdcCaptureExecutionBindingDescriptor, string, string, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyDictionary<string, string>?)
Section titled “ CdcCaptureDescriptor(string, string, string, string, string, string, string, CdcCaptureExecutionBindingDescriptor, string, string, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyDictionary<string, string>?)”Creates a new CDC capture descriptor.
public CdcCaptureDescriptor(string id, string displayName, string description, string sourceModuleId, string provider, string sourceId, string outboxId, CdcCaptureExecutionBindingDescriptor executionBinding, string mode = "log-based", string eventFormat = "debezium-envelope", IReadOnlyList<string>? resourceIds = null, IReadOnlyList<string>? tags = null, IReadOnlyDictionary<string, string>? metadata = null)Parameters
Section titled “Parameters”id string
The stable CDC capture identifier.
displayName string
The operator-facing CDC capture name.
description string
The human-readable CDC capture description.
sourceModuleId string
The module identifier that owns the CDC capture.
provider string
The logical provider identifier that supplies the change feed.
sourceId string
The logical source stream, database, or feed identifier.
outboxId string
The outbox identifier that receives captured publications.
executionBinding CdcCaptureExecutionBindingDescriptor
The authored or effective execution-binding answer for the CDC capture. When omitted, the capture starts unbound.
mode string
The capture mode such as wal, change-stream, or table-tail.
eventFormat string
The emitted change-event format such as debezium-envelope.
resourceIds IReadOnlyList<string>?
Optional resource identifiers such as tables, collections, or topics observed by the capture.
tags IReadOnlyList<string>?
Optional descriptive tags associated with the CDC capture.
metadata IReadOnlyDictionary<string, string>?
Optional operator-facing metadata associated with the CDC capture.
Properties
Section titled “Properties”Description
Section titled “ Description”Gets the human-readable CDC capture description.
public string Description { get; }Property Value
Section titled “Property Value”DisplayName
Section titled “ DisplayName”Gets the operator-facing CDC capture name.
public string DisplayName { get; }Property Value
Section titled “Property Value”EventFormat
Section titled “ EventFormat”Gets the emitted change-event format.
public string EventFormat { get; }Property Value
Section titled “Property Value”ExecutionBinding
Section titled “ ExecutionBinding”Gets the authored or effective execution-binding answer for the CDC capture.
public CdcCaptureExecutionBindingDescriptor ExecutionBinding { get; init; }Property Value
Section titled “Property Value”CdcCaptureExecutionBindingDescriptor
Gets the stable CDC capture identifier.
public string Id { get; }Property Value
Section titled “Property Value”Metadata
Section titled “ Metadata”Gets operator-facing metadata associated with the CDC capture.
public IReadOnlyDictionary<string, string> Metadata { get; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
Gets the capture mode.
public string Mode { get; }Property Value
Section titled “Property Value”OutboxId
Section titled “ OutboxId”Gets the outbox identifier that receives captured publications.
public string OutboxId { get; }Property Value
Section titled “Property Value”Provider
Section titled “ Provider”Gets the logical provider identifier that supplies the change feed.
public string Provider { get; }Property Value
Section titled “Property Value”ResourceIds
Section titled “ ResourceIds”Gets the resource identifiers observed by the capture.
public IReadOnlyList<string> ResourceIds { get; }Property Value
Section titled “Property Value”SourceId
Section titled “ SourceId”Gets the logical source stream, database, or feed identifier.
public string SourceId { get; }Property Value
Section titled “Property Value”SourceModuleId
Section titled “ SourceModuleId”Gets the identifier of the module that owns the CDC capture.
public string SourceModuleId { get; }Property Value
Section titled “Property Value”Gets descriptive tags associated with the CDC capture.
public IReadOnlyList<string> Tags { get; }Property Value
Section titled “Property Value”Methods
Section titled “Methods”WithExecutionBinding(CdcCaptureExecutionBindingDescriptor)
Section titled “ WithExecutionBinding(CdcCaptureExecutionBindingDescriptor)”Creates a copy of the CDC capture descriptor with a different execution-binding answer.
public CdcCaptureDescriptor WithExecutionBinding(CdcCaptureExecutionBindingDescriptor executionBinding)Parameters
Section titled “Parameters”executionBinding CdcCaptureExecutionBindingDescriptor
The execution-binding answer to apply.
Returns
Section titled “Returns”A new CDC capture descriptor with the requested execution binding.