ChangeFeedOptions Class

  • Reference

Definition

Namespace:
Microsoft.Azure.Documents.Client
Assemblies:
Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll
Packages:
Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Specifies the options associated with change feed methods (enumeration operations) in the Azure Cosmos DB service.

public sealed class ChangeFeedOptions
type ChangeFeedOptions = class
Public NotInheritable Class ChangeFeedOptions
Inheritance
Object
ChangeFeedOptions

Constructors

ChangeFeedOptions()

Properties

MaxItemCount

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

Gets or sets the partition key for the current request in the Azure Cosmos DB service.
PartitionKeyRangeId

Gets or sets the partition key range id for the current request in the Azure Cosmos DB service.
RequestContinuation

Gets or sets the request continuation token in the Azure Cosmos DB service.
SessionToken

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

Gets or sets 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. If this is specified, StartFromBeginning is ignored.

Applies to