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
- Alphabetic
- By Inheritance
- CommittableRecord
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
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
-
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
- val checkpointer: RecordProcessorCheckpointer
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @IntrinsicCandidate()
- val data: ByteBuffer
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val isLastInShard: Boolean
- val lastRecordDeferred: Deferred[F, Unit]
- val millisBehindLatest: Long
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- val record: KinesisClientRecord
- val recordProcessor: RecordProcessor[F]
- val recordProcessorStartingSequenceNumber: ExtendedSequenceNumber
- val sequenceNumber: String
- val shardId: String
- val subSequenceNumber: Long
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )