EventProcessorClient.GetCheckpointAsync(String, CancellationToken) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Returns a checkpoint for the Event Hub, consumer group, and partition ID associated with the event processor instance, so that processing for a given partition can be properly initialized.
protected override System.Threading.Tasks.Task<Azure.Messaging.EventHubs.Primitives.EventProcessorCheckpoint> GetCheckpointAsync (string partitionId, System.Threading.CancellationToken cancellationToken);override this.GetCheckpointAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.EventHubs.Primitives.EventProcessorCheckpoint>Protected Overrides Function GetCheckpointAsync (partitionId As String, cancellationToken As CancellationToken) As Task(Of EventProcessorCheckpoint)Parameters
- partitionId
- String
The ID of the partition for which to retrieve the checkpoint.
- cancellationToken
- CancellationToken
A CancellationToken instance to signal the request to cancel the processing. This is most likely to occur when the processor is shutting down.
Returns
The checkpoint for the processor to take into account when initializing partition.
Remarks
Should a partition not have a corresponding checkpoint, the default starting position set by the PartitionInitializingAsync handler will be applied. If no partition-specific starting point was specified, the DefaultStartingPosition will be used to initialize the partition for processing.
