Class Checkpoint
java.lang.Object
com.azure.messaging.eventhubs.models.Checkpoint
A model class to hold checkpoint data. A checkpoint represents the last successfully processed event for a
particular partition of an Event Hub.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the consumer group name associated with this checkpoint.Gets the Event Hub name associated with this checkpoint.Returns the fully qualified namespace of the Event Hub.Gets the offset of the last successfully processed event to store as checkpoint.Gets the partition id associated with this checkpoint.Gets the sequence number of the last successfully processed event to store as checkpoint.setConsumerGroup
(String consumerGroup) Sets the consumer group name associated with this checkpoint.setEventHubName
(String eventHubName) Sets the Event Hub name associated with this checkpoint.setFullyQualifiedNamespace
(String fullyQualifiedNamespace) Sets the fully qualified namespace of the Event Hub.Sets the offset of the last successfully processed event to store as checkpoint.setPartitionId
(String partitionId) Sets the partition id associated with this checkpoint.setSequenceNumber
(Long sequenceNumber) Sets the sequence number of the last successfully processed event to store as checkpoint.
-
Constructor Details
-
Checkpoint
public Checkpoint()Creates a new instance.
-
-
Method Details
-
getFullyQualifiedNamespace
Returns the fully qualified namespace of the Event Hub.- Returns:
- the fully qualified namespace of the Event Hub.
-
setFullyQualifiedNamespace
Sets the fully qualified namespace of the Event Hub.- Parameters:
fullyQualifiedNamespace
- the fully qualified namespace of the Event Hub.- Returns:
- The updated
Checkpoint
instance.
-
getEventHubName
Gets the Event Hub name associated with this checkpoint.- Returns:
- The Event Hub name associated with this checkpoint.
-
setEventHubName
Sets the Event Hub name associated with this checkpoint.- Parameters:
eventHubName
- The Event Hub name associated with this checkpoint.- Returns:
- The updated
Checkpoint
instance.
-
getConsumerGroup
Gets the consumer group name associated with this checkpoint.- Returns:
- The consumer group name associated with this checkpoint.
-
setConsumerGroup
Sets the consumer group name associated with this checkpoint.- Parameters:
consumerGroup
- The consumer group name associated with this checkpoint.- Returns:
- The updated
Checkpoint
instance.
-
getPartitionId
Gets the partition id associated with this checkpoint.- Returns:
- The partition id associated with this checkpoint.
-
setPartitionId
Sets the partition id associated with this checkpoint.- Parameters:
partitionId
- The partition id associated with this checkpoint.- Returns:
- The updated
Checkpoint
instance.
-
getOffset
Gets the offset of the last successfully processed event to store as checkpoint.- Returns:
- The offset of the last successfully processed event to store as checkpoint.
-
setOffset
Sets the offset of the last successfully processed event to store as checkpoint.- Parameters:
offset
- The offset of the last successfully processed event to store as checkpoint.- Returns:
- The updated
Checkpoint
instance.
-
getSequenceNumber
Gets the sequence number of the last successfully processed event to store as checkpoint.- Returns:
- The sequence number of the last successfully processed event to store as checkpoint.
-
setSequenceNumber
Sets the sequence number of the last successfully processed event to store as checkpoint.- Parameters:
sequenceNumber
- The sequence number of the last successfully processed event to store as checkpoint.- Returns:
- The updated
Checkpoint
instance.
-