CheckpointStore.GetCheckpointAsync Method

Definition

Namespace:

Azure.Messaging.EventHubs.Primitives

Assembly:

Azure.Messaging.EventHubs.dll

Package:

Azure.Messaging.EventHubs v5.11.3

Source:

CheckpointStore.cs

Requests checkpoint information for a specific partition, allowing an event processor to resume reading from the next event in the stream.

public abstract System.Threading.Tasks.Task<Azure.Messaging.EventHubs.Primitives.EventProcessorCheckpoint> GetCheckpointAsync (string fullyQualifiedNamespace, string eventHubName, string consumerGroup, string partitionId, System.Threading.CancellationToken cancellationToken);

abstract member GetCheckpointAsync : string * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.EventHubs.Primitives.EventProcessorCheckpoint>

Public MustOverride Function GetCheckpointAsync (fullyQualifiedNamespace As String, eventHubName As String, consumerGroup As String, partitionId As String, cancellationToken As CancellationToken) As Task(Of EventProcessorCheckpoint)

Parameters

fullyQualifiedNamespace

String

The fully qualified Event Hubs namespace the ownership are associated with. This is likely to be similar to {yournamespace}.servicebus.windows.net.

eventHubName

String

The name of the specific Event Hub the ownership are associated with, relative to the Event Hubs namespace that contains it.

consumerGroup

String

The name of the consumer group the checkpoint is associated with.

partitionId

String

The identifier of the partition to read a checkpoint for.

cancellationToken

CancellationToken

A CancellationToken instance to signal a request to cancel the operation.

Returns

Task<EventProcessorCheckpoint>

An EventProcessorCheckpoint instance, if a checkpoint was found for the requested partition; otherwise, null.