CheckpointStore.UpdateCheckpointAsync Method

Definition

Namespace:

Azure.Messaging.EventHubs.Primitives

Assembly:

Azure.Messaging.EventHubs.dll

Package:

Azure.Messaging.EventHubs v5.11.3

Overloads

UpdateCheckpointAsync(String, String, String, String, Int64, Nullable<Int64>, CancellationToken)	Creates or updates a checkpoint for a specific partition, identifying a position in the partition's event stream that an event processor should begin reading from.
UpdateCheckpointAsync(String, String, String, String, String, CheckpointPosition, CancellationToken)	Creates or updates a checkpoint for a specific partition, identifying a position in the partition's event stream that an event processor should begin reading from.

UpdateCheckpointAsync(String, String, String, String, Int64, Nullable<Int64>, CancellationToken)

Source:

CheckpointStore.cs

Creates or updates a checkpoint for a specific partition, identifying a position in the partition's event stream that an event processor should begin reading from.

public virtual System.Threading.Tasks.Task UpdateCheckpointAsync (string fullyQualifiedNamespace, string eventHubName, string consumerGroup, string partitionId, long offset, long? sequenceNumber, System.Threading.CancellationToken cancellationToken);

abstract member UpdateCheckpointAsync : string * string * string * string * int64 * Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.UpdateCheckpointAsync : string * string * string * string * int64 * Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function UpdateCheckpointAsync (fullyQualifiedNamespace As String, eventHubName As String, consumerGroup As String, partitionId As String, offset As Long, sequenceNumber As Nullable(Of Long), cancellationToken As CancellationToken) As Task

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 the checkpoint is for.

offset

Int64

The offset to associate with the checkpoint, intended as informational metadata. This will only be used from positioning if there is no value provided for sequenceNumber.

sequenceNumber

Nullable<Int64>

The sequence number to associate with the checkpoint, indicating that a processor should begin reading from the next event in the stream.

cancellationToken

CancellationToken

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

Returns

Task

UpdateCheckpointAsync(String, String, String, String, String, CheckpointPosition, CancellationToken)

Source:

CheckpointStore.cs

Creates or updates a checkpoint for a specific partition, identifying a position in the partition's event stream that an event processor should begin reading from.

public virtual System.Threading.Tasks.Task UpdateCheckpointAsync (string fullyQualifiedNamespace, string eventHubName, string consumerGroup, string partitionId, string clientIdentifier, Azure.Messaging.EventHubs.Processor.CheckpointPosition startingPosition, System.Threading.CancellationToken cancellationToken);

abstract member UpdateCheckpointAsync : string * string * string * string * string * Azure.Messaging.EventHubs.Processor.CheckpointPosition * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.UpdateCheckpointAsync : string * string * string * string * string * Azure.Messaging.EventHubs.Processor.CheckpointPosition * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function UpdateCheckpointAsync (fullyQualifiedNamespace As String, eventHubName As String, consumerGroup As String, partitionId As String, clientIdentifier As String, startingPosition As CheckpointPosition, cancellationToken As CancellationToken) As Task

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 the checkpoint is for.

clientIdentifier

String

The unique identifier of the client that authored this checkpoint.

startingPosition

CheckpointPosition

The starting position to associate with the checkpoint, indicating that a processor should begin reading from the next event in the stream.

cancellationToken

CancellationToken

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

Returns

Task