Class Checkpoint

java.lang.Object
com.azure.messaging.eventhubs.models.Checkpoint

public class Checkpoint extends Object
A model class to hold checkpoint data. A checkpoint represents the last successfully processed event by a PartitionProcessor for a particular partition of an Event Hub.
  • Constructor Details

    • Checkpoint

      public Checkpoint()
  • Method Details

    • getFullyQualifiedNamespace

      public String getFullyQualifiedNamespace()
      Returns the fully qualified namespace of the Event Hub.
      Returns:
      the fully qualified namespace of the Event Hub.
    • setFullyQualifiedNamespace

      public Checkpoint setFullyQualifiedNamespace(String fullyQualifiedNamespace)
      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

      public String getEventHubName()
      Gets the Event Hub name associated with this checkpoint.
      Returns:
      The Event Hub name associated with this checkpoint.
    • setEventHubName

      public Checkpoint setEventHubName(String eventHubName)
      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

      public String getConsumerGroup()
      Gets the consumer group name associated with this checkpoint.
      Returns:
      The consumer group name associated with this checkpoint.
    • setConsumerGroup

      public Checkpoint setConsumerGroup(String consumerGroup)
      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

      public String getPartitionId()
      Gets the partition id associated with this checkpoint.
      Returns:
      The partition id associated with this checkpoint.
    • setPartitionId

      public Checkpoint setPartitionId(String partitionId)
      Sets the partition id associated with this checkpoint.
      Parameters:
      partitionId - The partition id associated with this checkpoint.
      Returns:
      The updated Checkpoint instance.
    • getOffset

      public Long 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

      public Checkpoint setOffset(Long offset)
      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

      public Long 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

      public Checkpoint setSequenceNumber(Long sequenceNumber)
      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.