com.amazonaws.services.kinesis.connectors.interfaces

Interface IBuffer<T>

Type Parameters:

T - the data type stored in the record

All Known Implementing Classes:

BasicMemoryBuffer, UnmodifiableBuffer

public interface IBuffer<T>

IBuffer defines a buffer used to store records streamed through Amazon Kinesis. It is a part of the IKinesisConnectorPipeline utilized by the KinesisConnectorRecordProcessor. Records are stored in the buffer by calling the consumeRecord method. The buffer has two size limits defined: total byte count and total number of records. The shouldFlush() method may indicate that the buffer is full based on these limits.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the buffer
void	consumeRecord(T record, int recordBytes, String sequenceNumber) Stores the record in the buffer
long	getBytesToBuffer() Get the byte size limit of data stored in the buffer before the records are flushed to the emitter
String	getFirstSequenceNumber() Get the sequence number of the first record stored in the buffer.
String	getLastSequenceNumber() Get the sequence number of the last record stored in the buffer.
long	getMillisecondsToBuffer() Get the time limit in milliseconds before the records are flushed to the emitter
long	getNumRecordsToBuffer() Get the record number limit of data stored in the buffer before the records are flushed to the emitter
List<T>	getRecords() Get the records stored in the buffer
boolean	shouldFlush() Returns true if the buffer is full and stored records should be sent to the emitter

Method Detail

getBytesToBuffer

long getBytesToBuffer()

Get the byte size limit of data stored in the buffer before the records are flushed to the emitter

Returns:

byte size limit of buffer

getNumRecordsToBuffer

long getNumRecordsToBuffer()

Get the record number limit of data stored in the buffer before the records are flushed to the emitter

Returns:

record number limit of buffer

getMillisecondsToBuffer

long getMillisecondsToBuffer()

Get the time limit in milliseconds before the records are flushed to the emitter

Returns:

time limit in milleseconds

shouldFlush

boolean shouldFlush()

Returns true if the buffer is full and stored records should be sent to the emitter

Returns:

true if records should be sent to the emitter followed by clearing the buffer

consumeRecord

void consumeRecord(T record,
                   int recordBytes,
                   String sequenceNumber)

Stores the record in the buffer

Parameters:

record - record to be processed

recordBytes - size of the record data in bytes

sequenceNumber - Amazon Kinesis sequence identifier

clear

void clear()

Clears the buffer

getFirstSequenceNumber

String getFirstSequenceNumber()

Get the sequence number of the first record stored in the buffer. Used for bookkeeping and uniquely identifying items in the buffer.

Returns:

the sequence number of the first record stored in the buffer

getLastSequenceNumber

String getLastSequenceNumber()

Get the sequence number of the last record stored in the buffer. Used for bookkeeping and uniquely identifying items in the buffer.

Returns:

the sequence number of the last record stored in the buffer

getRecords

List<T> getRecords()

Get the records stored in the buffer

Returns:

the records stored in the buffer