Packages

final case class CommittableRecord[F[_]](shardId: String, recordProcessorStartingSequenceNumber: ExtendedSequenceNumber, millisBehindLatest: Long, record: KinesisClientRecord, recordProcessor: RecordProcessor[F], checkpointer: RecordProcessorCheckpointer, lastRecordDeferred: Deferred[F, Unit], isLastInShard: Boolean = false)(implicit F: Sync[F]) extends Product with Serializable

A message from Kinesis that is able to be committed.

shardId

The unique identifier for the shard from which this record originated

recordProcessorStartingSequenceNumber

The starting sequence number for the RecordProcessor which received this record

millisBehindLatest

Milleseconds behind the latest record, used to detect if the consumer is lagging the producer

record

KinesisClientRecord representing the original record received by Kinesis.

recordProcessor

Reference to the RecordProcessor that is responsible for processing this message

checkpointer

Reference to the RecordProcessorCheckpointer responsible for committing the record

Source
CommittableRecord.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CommittableRecord
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CommittableRecord(shardId: String, recordProcessorStartingSequenceNumber: ExtendedSequenceNumber, millisBehindLatest: Long, record: KinesisClientRecord, recordProcessor: RecordProcessor[F], checkpointer: RecordProcessorCheckpointer, lastRecordDeferred: Deferred[F, Unit], isLastInShard: Boolean = false)(implicit F: Sync[F])

    shardId

    The unique identifier for the shard from which this record originated

    recordProcessorStartingSequenceNumber

    The starting sequence number for the RecordProcessor which received this record

    millisBehindLatest

    Milleseconds behind the latest record, used to detect if the consumer is lagging the producer

    record

    KinesisClientRecord representing the original record received by Kinesis.

    recordProcessor

    Reference to the RecordProcessor that is responsible for processing this message

    checkpointer

    Reference to the RecordProcessorCheckpointer responsible for committing the record

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 canCheckpoint: F[Boolean]

    Determines if the RecordProcesor is in a state that is allowed to commit this record.

    Determines if the RecordProcesor is in a state that is allowed to commit this record.

    returns

    F containing a Boolean indicator of commit availability

  6. def checkpoint: F[Unit]

    Commits this record.

    Commits this record. If it is the last record in the shard, completes the lastRecordDeferred

    returns

    F of Unit

  7. val checkpointer: RecordProcessorCheckpointer
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. val data: ByteBuffer
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. val isLastInShard: Boolean
  15. val lastRecordDeferred: Deferred[F, Unit]
  16. val millisBehindLatest: Long
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. val record: KinesisClientRecord
  22. val recordProcessor: RecordProcessor[F]
  23. val recordProcessorStartingSequenceNumber: ExtendedSequenceNumber
  24. val sequenceNumber: String
  25. val shardId: String
  26. val subSequenceNumber: Long
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped