sealed abstract class CommittableOffset[F[_]] extends AnyRef

CommittableOffset represents an offsetAndMetadata for a topicPartition, along with the ability to commit that offset to Kafka with commit. Note that offsets are normally committed in batches for performance reasons. Pipes like commitBatchWithin use CommittableOffsetBatch to commit the offsets in batches.

While normally not necessary, CommittableOffset#apply can be used to create a new instance.

Source
CommittableOffset.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CommittableOffset
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def batch: CommittableOffsetBatch[F]

    The CommittableOffset as a CommittableOffsetBatch.

  2. abstract def commit: F[Unit]

    Commits the offsetAndMetadata for the topicPartition to Kafka.

    Commits the offsetAndMetadata for the topicPartition to Kafka. Note that offsets are normally committed in batches for performance reasons. Prefer pipes like commitBatchWithin or CommittableOffsetBatch for that reason.

  3. abstract def consumerGroupId: Option[String]

    The consumer group ID of the consumer that fetched the offsetAndMetadata from the topicPartition from Kafka.

    Required for committing offsets within a transaction.

  4. abstract def offsetAndMetadata: OffsetAndMetadata

    The offset and metadata for the topicPartition, which can be committed using commit.

  5. abstract def offsets: Map[TopicPartition, OffsetAndMetadata]

    The topicPartition and offsetAndMetadata as a Map.

    The topicPartition and offsetAndMetadata as a Map. This is provided for convenience and is always guaranteed to be equivalent to the following.

    Map(topicPartition -> offsetAndMetadata)
  6. abstract def topicPartition: TopicPartition

    The topic and partition for which offsetAndMetadata can be committed using commit.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped