ILease Interface

Definition

Namespace:

Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement

Assembly:

Microsoft.Azure.Documents.ChangeFeedProcessor.dll

Package:

Microsoft.Azure.DocumentDB.ChangeFeedProcessor v2.4.0

Represents a lease that is persisted as a document in the lease collection. Leases are used to:

• Keep track of the IChangeFeedProcessor progress for a particular Partition Key Range.
• Distribute load between different instances of IChangeFeedProcessor.
• Ensure reliable recovery for cases when an instance of IChangeFeedProcessor gets disconnected, hangs or crashes.

public interface ILease

type ILease = interface

Public Interface ILease

Properties

ConcurrencyToken	Gets the Concurrency Token.
ContinuationToken	Gets or sets the Continuation Token. Continuation Token is used to determine the last processed point of the Change Feed.
Id	Gets the lease Id.
Owner	Gets or sets the host name owner of the lease. The Owner keeps track which IChangeFeedProcessor is currently processing that Partition Key Range.
PartitionId	Gets the partition associated with the lease.
Properties	Gets or sets custom lease properties which can be managed from IParitionLoadBalancingStrategy.
Timestamp	Gets or sets the Timestamp of the lease. Timestamp is used to determine lease expiration.