Class/Object

fs2.kafka

CommittableOffset

Related Docs: object CommittableOffset | package kafka

Permalink

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. Sinks like commitBatch and commitBatchWithin use CommittableOffsetBatch to commit the offsets in batches.

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

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. All

Abstract Value Members

  1. abstract def batch: CommittableOffsetBatch[F]

    Permalink

    The CommittableOffset as a CommittableOffsetBatch.

  2. abstract def commit: F[Unit]

    Permalink

    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 to use sinks like commitBatch or commitBatchWithin, or CommittableOffsetBatch for that reason.

  3. abstract def offsetAndMetadata: OffsetAndMetadata

    Permalink

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

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

    Permalink

    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)

  5. abstract def topicPartition: TopicPartition

    Permalink

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

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped