com.amazonaws.services.kinesis.clientlibrary.interfaces.v2

Interface IRecordProcessor

All Known Implementing Classes:

MultiLangRecordProcessor

public interface IRecordProcessor

The Amazon Kinesis Client Library will instantiate record processors to process data records fetched from Amazon Kinesis.

Method Summary

Modifier and Type	Method and Description
void	initialize(InitializationInput initializationInput) Invoked by the Amazon Kinesis Client Library before data records are delivered to the RecordProcessor instance (via processRecords).
void	processRecords(ProcessRecordsInput processRecordsInput) Process data records.
void	shutdown(ShutdownInput shutdownInput) Invoked by the Amazon Kinesis Client Library to indicate it will no longer send data records to this RecordProcessor instance.

Method Detail

initialize

void initialize(InitializationInput initializationInput)

Invoked by the Amazon Kinesis Client Library before data records are delivered to the RecordProcessor instance (via processRecords).

Parameters:

initializationInput - Provides information related to initialization

processRecords

void processRecords(ProcessRecordsInput processRecordsInput)

Process data records. The Amazon Kinesis Client Library will invoke this method to deliver data records to the application. Upon fail over, the new instance will get records with sequence number > checkpoint position for each partition key.

Parameters:

processRecordsInput - Provides the records to be processed as well as information and capabilities related to them (eg checkpointing).

shutdown

void shutdown(ShutdownInput shutdownInput)

Invoked by the Amazon Kinesis Client Library to indicate it will no longer send data records to this RecordProcessor instance.

Warning

When the value of ShutdownInput.getShutdownReason() is ShutdownReason.TERMINATE it is required that you checkpoint. Failure to do so will result in an IllegalArgumentException, and the KCL no longer making progress.

Parameters:

shutdownInput - Provides information and capabilities (eg checkpointing) related to shutdown of this record processor.