Checkpoint interface
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
| consumer |
The consumer group name |
| event |
The event hub name |
| fully |
The fully qualified Event Hubs namespace. This is likely to be similar to .servicebus.windows.net |
| offset | The offset of the event. |
| partition |
The identifier of the Event Hub partition |
| sequence |
The sequence number of the event |
Property Details
consumerGroup
The consumer group name
consumerGroup: stringProperty Value
string
eventHubName
The event hub name
eventHubName: stringProperty Value
string
fullyQualifiedNamespace
The fully qualified Event Hubs namespace. This is likely to be similar to .servicebus.windows.net
fullyQualifiedNamespace: stringProperty Value
string
offset
The offset of the event.
offset: numberProperty Value
number
partitionId
The identifier of the Event Hub partition
partitionId: stringProperty Value
string
sequenceNumber
The sequence number of the event
sequenceNumber: numberProperty Value
number