Class TopicPartitionOffset

java.lang.Object
org.springframework.kafka.support.TopicPartitionOffset

public class TopicPartitionOffset extends Object
A configuration container to represent a topic name, partition number and, optionally, an offset for it. The offset can be:
  • null - do nothing;
  • positive (including 0) - seek to EITHER the absolute offset within the partition or an offset relative to the current position for this consumer, depending on isRelativeToCurrent().
  • negative - seek to EITHER the offset relative to the current last offset within the partition: consumer.seekToEnd() + initialOffset OR the relative to the current offset for this consumer (if any), depending on isRelativeToCurrent().
Offsets are applied when the container is start()ed. This class is used when manually assigning partitions and for deferred seek operations.
Since:
2.3
Author:
Artem Bilan, Gary Russell, Soby Chacko
  • Constructor Details

  • Method Details

    • getTopicPartition

      public org.apache.kafka.common.TopicPartition getTopicPartition()
    • getPartition

      public int getPartition()
    • getTopic

      public String getTopic()
    • getOffset

      public Long getOffset()
    • setOffset

      public void setOffset(Long offset)
      Set the offset.
      Parameters:
      offset - the offset.
      Since:
      2.5.5
    • isRelativeToCurrent

      public boolean isRelativeToCurrent()
    • setRelativeToCurrent

      public void setRelativeToCurrent(boolean relativeToCurrent)
      Set whether the offset is relative to the current position.
      Parameters:
      relativeToCurrent - true for relative to current.
      Since:
      2.5.5
    • getPosition

      public TopicPartitionOffset.SeekPosition getPosition()
    • getOffsetComputeFunction

      public Function<Long,Long> getOffsetComputeFunction()
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object