Share via

ChangeFeedObserverContext.CheckpointAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Documents.ChangeFeedProcessor
Assembly:
Microsoft.Azure.Documents.ChangeFeedProcessor.dll
Package:
Microsoft.Azure.DocumentDB.ChangeFeedProcessor v2.4.0

Checkpoints progress of a stream. This method is valid only if manual checkpoint was configured. Client may accept multiple change feed batches to process in parallel. Once first N document processing was finished the client can call checkpoint on the last completed batches in the row. In case of automatic checkpointing this is method throws.

public abstract System.Threading.Tasks.Task CheckpointAsync ();
abstract member CheckpointAsync : unit -> System.Threading.Tasks.Task
Public MustOverride Function CheckpointAsync () As Task

Returns

Task

A Task.

Exceptions

LeaseLostException

Thrown if other host acquired the lease or the lease was deleted

Applies to