ChangeFeedHostOptions Class

Definition

Namespace:

Microsoft.Azure.Documents.ChangeFeedProcessor

Assembly:

Microsoft.Azure.Documents.ChangeFeedProcessor.dll

Package:

Microsoft.Azure.DocumentDB.ChangeFeedProcessor v2.4.0

Caution

Switch to the ChangeFeedProcessorBuilder class and use its WithChangeFeedProcessorOptions method to pass the options.

Options to control various aspects of partition distribution happening within ChangeFeedEventHost instance.

[System.Obsolete("Switch to the ChangeFeedProcessorBuilder class and use its WithChangeFeedProcessorOptions method to pass the options.")]
public class ChangeFeedHostOptions

[<System.Obsolete("Switch to the ChangeFeedProcessorBuilder class and use its WithChangeFeedProcessorOptions method to pass the options.")>]
type ChangeFeedHostOptions = class

Public Class ChangeFeedHostOptions

Inheritance

Object

ChangeFeedHostOptions

Attributes

ObsoleteAttribute

Constructors

ChangeFeedHostOptions()

Initializes a new instance of the ChangeFeedHostOptions class.

Properties

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.
IsAutoCheckpointEnabled	Obsolete. Gets or sets a value indicating whether the host will checkpoint leases automatically. When this is set to false, use ChangeFeedObserverContext.CheckpointAsync for manual control of checkpoint.
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 ChangeFeedEventHost 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 ChangeFeedEventHost 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 ChangeFeedEventHost instance.