Share via


ChangeFeedProcessorOptions Class

Definition

Options to control various aspects of partition distribution happening within Microsoft.Azure.Documents.ChangeFeedProcessor.ChangeFeedProcessor instance.

public class ChangeFeedProcessorOptions
type ChangeFeedProcessorOptions = class
Public Class ChangeFeedProcessorOptions
Inheritance
ChangeFeedProcessorOptions

Constructors

ChangeFeedProcessorOptions()

Initializes a new instance of the ChangeFeedProcessorOptions class.

Properties

ChangeFeedTimeout

Gets or sets the timeout for change feed.

CheckpointFrequency

Gets or sets the frequency how often to checkpoint leases.

FeedPollDelay

Gets or sets the delay in between polling a partition for new changes on the feed, after all current changes are drained.

LeaseAcquireInterval

Gets or sets the interval to kick off a task to compute if partitions are distributed evenly among known host instances.

LeaseExpirationInterval

Gets or sets the interval for which the lease is taken on a lease representing a partition. If the lease is not renewed within this interval, it will cause it to expire and ownership of the partition will move to another Microsoft.Azure.Documents.ChangeFeedProcessor.ChangeFeedProcessor instance.

LeasePrefix

Gets or sets a prefix to be used as part of the lease id. This can be used to support multiple instances of Microsoft.Azure.Documents.ChangeFeedProcessor.ChangeFeedProcessor instances pointing at the same feed while using the same auxiliary collection.

LeaseRenewInterval

Gets or sets renew interval for all leases for partitions currently held by Microsoft.Azure.Documents.ChangeFeedProcessor.ChangeFeedProcessor instance.

MaxItemCount

Gets or sets the maximum number of items to be returned in the enumeration operation in the Azure Cosmos DB service.

SessionToken

Gets or sets the session token for use with session consistency in the Azure Cosmos DB service.

StartContinuation

Gets or sets the start request continuation token to start looking for changes after.

StartFromBeginning

Gets or sets a value indicating whether change feed in the Azure Cosmos DB service should start from beginning (true) or from current (false). By default it's start from current (false).

StartTime

Gets or sets the time (exclusive) to start looking for changes after.

Applies to