Checkpoint interface

Package:

@azure/event-hubs

A checkpoint is meant to represent the last successfully processed event by the user from a particular partition of a consumer group in an Event Hub instance.

When the updateCheckpoint() method on the PartitionProcessor class is called by the user, a Checkpoint is created internally. It is then stored in the storage solution implemented by the CheckpointManager chosen by the user when creating an EventProcessor.

Users are never expected to interact with Checkpoint directly. This interface exists to support the internal workings of EventProcessor and CheckpointManager.

Properties

consumerGroup	The consumer group name
eventHubName	The event hub name
fullyQualifiedNamespace	The fully qualified Event Hubs namespace. This is likely to be similar to .servicebus.windows.net
offset	The offset of the event.
partitionId	The identifier of the Event Hub partition
sequenceNumber	The sequence number of the event

Property Details

consumerGroup

The consumer group name

consumerGroup: string

Property Value

string

eventHubName

The event hub name

eventHubName: string

Property Value

string

fullyQualifiedNamespace

The fully qualified Event Hubs namespace. This is likely to be similar to .servicebus.windows.net

fullyQualifiedNamespace: string

Property Value

string

offset

The offset of the event.

offset: number

Property Value

number

partitionId

The identifier of the Event Hub partition

partitionId: string

Property Value

string

sequenceNumber

The sequence number of the event

sequenceNumber: number

Property Value

number