Package com.azure.messaging.eventhubs.models

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 for a particular partition of an Event Hub.
See Also:

  • Constructor Details

    • Checkpoint

      public Checkpoint()
      Creates a new instance.

  • 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

      @Deprecated public Long getOffset()
      Deprecated.
      This method is obsolete and should no longer be used. Please use getOffsetString()
      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. null if the information has not been set, or the offset cannot be represented as a long.

    • setOffset

      @Deprecated public Checkpoint setOffset(Long offset)
      Deprecated.
      This method is obsolete and should no longer be used. Please use setOffsetString(String).
      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.

    • getOffsetString

      public String getOffsetString()
      Gets the offset of the last successfully processed event to store as checkpoint.
      Returns:
      Offset of the last successfully processed event to store as checkpoint.

    • setOffsetString

      public Checkpoint setOffsetString(String offsetString)
      Sets the offset of the last successfully processed event to store as checkpoint.
      Parameters:
      offsetString - 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.