Table of Contents

Class FirestoreCdcOptions

Namespace
Excalibur.Cdc.Firestore
Assembly
Excalibur.Cdc.Firestore.dll

Configuration options for Firestore CDC processor.

public sealed class FirestoreCdcOptions
Inheritance
FirestoreCdcOptions
Inherited Members

Properties

ChannelCapacity

Gets or sets the channel capacity for buffering incoming events.

[Range(1, 2147483647)]
public int ChannelCapacity { get; set; }

Property Value

int

Remarks

Events are buffered in a bounded channel. If the channel is full, incoming events will wait until space is available.

CollectionPath

Gets or sets the Firestore collection path to watch.

[Required]
public string CollectionPath { get; set; }

Property Value

string

Remarks

This can be a simple collection path (e.g., "users") or a nested path (e.g., "organizations/org1/members").

MaxBatchSize

Gets or sets the maximum number of events to process per batch.

[Range(1, 2147483647)]
public int MaxBatchSize { get; set; }

Property Value

int

MaxWaitTime

Gets or sets the maximum time to wait for new changes in a single batch operation.

public TimeSpan MaxWaitTime { get; set; }

Property Value

TimeSpan

PollInterval

Gets or sets the interval between checking for new changes when idle.

public TimeSpan PollInterval { get; set; }

Property Value

TimeSpan

Remarks

For push-based Firestore listeners, this represents the minimum interval between batch processing operations.

ProcessorName

Gets or sets the unique processor name for position tracking.

[Required]
public string ProcessorName { get; set; }

Property Value

string

StartPosition

Gets or sets the starting position for stream processing.

public FirestoreCdcPosition? StartPosition { get; set; }

Property Value

FirestoreCdcPosition

Remarks

If null, uses the last confirmed position from the state store, or starts from the beginning if no position is found.

UseCollectionGroup

Gets or sets a value indicating whether to use a collection group query.

public bool UseCollectionGroup { get; set; }

Property Value

bool

Remarks

When true, listens to all collections with the same ID across the database. For example, if CollectionPath is "comments", this will listen to all "comments" subcollections under any parent.

Methods

Validate()

Validates the options.

public void Validate()

Exceptions

InvalidOperationException

Thrown if the options are invalid.