Table of Contents

Class ChangeFeedOptions

Namespace
Excalibur.Data.CloudNative
Assembly
Excalibur.Data.Abstractions.dll

Default implementation of IChangeFeedOptions.

public sealed class ChangeFeedOptions : IChangeFeedOptions
Inheritance
ChangeFeedOptions
Implements
Inherited Members

Fields

Default

Gets the default change feed options (start from now, batch size 100).

public static readonly ChangeFeedOptions Default

Field Value

ChangeFeedOptions

FromBeginning

Gets options to start from the beginning of the feed.

public static readonly ChangeFeedOptions FromBeginning

Field Value

ChangeFeedOptions

Properties

ContinuationToken

Gets the continuation token to resume from (if resuming).

public string? ContinuationToken { get; init; }

Property Value

string

MaxBatchSize

Gets the maximum number of items to process in a batch.

public int MaxBatchSize { get; init; }

Property Value

int

MaxConsecutiveCheckpointFailures

Gets the number of consecutive checkpoint-save failures after which a subscription reports itself degraded rather than continuing silently. Must be positive.

public int MaxConsecutiveCheckpointFailures { get; init; }

Property Value

int

Defaults to 10.

PartitionKeyFilter

Gets the partition key to filter changes (null for all partitions).

public IPartitionKey? PartitionKeyFilter { get; init; }

Property Value

IPartitionKey

PollingInterval

Gets the polling interval for providers that use polling.

public TimeSpan PollingInterval { get; init; }

Property Value

TimeSpan

StartPosition

Gets the starting position for the subscription.

public ChangeFeedStartPosition StartPosition { get; init; }

Property Value

ChangeFeedStartPosition

StartTimestamp

Gets the specific timestamp to start from (if using StartFromTimestamp).

public DateTimeOffset? StartTimestamp { get; init; }

Property Value

DateTimeOffset?

Methods

FromContinuation(string)

Creates options to resume from a continuation token.

public static ChangeFeedOptions FromContinuation(string continuationToken)

Parameters

continuationToken string

The continuation token to resume from.

Returns

ChangeFeedOptions

Change feed options configured to resume from the token.

FromTimestamp(DateTimeOffset)

Creates options to start from a specific timestamp.

public static ChangeFeedOptions FromTimestamp(DateTimeOffset timestamp)

Parameters

timestamp DateTimeOffset

The timestamp to start from.

Returns

ChangeFeedOptions

Change feed options configured to start from the timestamp.