CommittableConsumerRecord

fs2.kafka.CommittableConsumerRecord

See theCommittableConsumerRecord companion object

sealed abstract class CommittableConsumerRecord[F[_], +K, +V]

CommittableConsumerRecord is a Kafka record along with an instance of CommittableOffset, which can be used commit the record offset to Kafka. Offsets are normally committed in batches, either using CommittableOffsetBatch or via pipes, like commitBatchWithin. If you are not committing offsets to Kafka then you can use record to get the underlying record and also discard the offset.

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

Attributes

A CommittableOffset instance, providing a way to commit the record offset to Kafka.

A CommittableOffset instance, providing a way to commit the record offset to Kafka. This is normally done in batches as it achieves better performance. Pipes like commitBatchWithin use CommittableOffsetBatch to batch and commit offsets.

The Kafka record for the CommittableConsumerRecord.

The Kafka record for the CommittableConsumerRecord. If you are not committing offsets to Kafka, simply use this to get the ConsumerRecord and discard the offset.

In this article

Generated with