CheckpointPosition Struct
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.
The position in a partition's event stream to use when updating a checkpoint, indicating that an event processor should begin reading from the next event.
public struct CheckpointPosition : IEquatable<Azure.Messaging.EventHubs.Processor.CheckpointPosition>
type CheckpointPosition = struct
Public Structure CheckpointPosition
Implements IEquatable(Of CheckpointPosition)
- Inheritance
-
CheckpointPosition
- Implements
Constructors
CheckpointPosition(String, Int64) |
Initializes a new instance of the CheckpointPosition struct. |
Properties
Offset |
The offset to associate with the checkpoint. This indicates that a processor should begin reading from the next event in the stream. |
SequenceNumber |
The sequence number to associate with the checkpoint. The sequence number is intended to be informational, and will only be used for positioning if no Offset is set. |
Methods
Equals(CheckpointPosition) |
Determines whether the specified CheckpointPosition is equal to this instance. |
FromEvent(EventData) |
Initializes a new instance of the CheckpointPosition from an EventData instance. |
ToString() |
Converts the instance to string representation. |
Operators
Equality(CheckpointPosition, CheckpointPosition) |
Determines whether the specified CheckpointPosition instances are equal to each other. |
Inequality(CheckpointPosition, CheckpointPosition) |
Determines whether the specified CheckpointPosition instances are not equal to each other. |