com.amazonaws.services.kinesis.connectors.interfaces

Interface IEmitter<T>

Type Parameters:

T - the data type stored in the record

All Known Implementing Classes:

DynamoDBEmitter, ElasticsearchEmitter, RedshiftBasicEmitter, RedshiftManifestEmitter, S3Emitter, S3ManifestEmitter

public interface IEmitter<T>

IEmitter takes a full buffer and processes the stored records. The IEmitter is a member of the IKinesisConnectorPipeline that "emits" the objects that have been deserialized by the ITransformer. The emit() method is invoked when the buffer is full (possibly to persist the records or send them to another Amazon Kinesis stream). After emitting the records, the IEmitter should return a list of records that could not be processed. Implementations may choose to fail the entire set of records in the buffer or to fail records individually.

Method Summary

Modifier and Type	Method and Description
List<T>	emit(UnmodifiableBuffer<T> buffer) Invoked when the buffer is full.
void	fail(List<T> records) This method defines how to handle a set of records that cannot successfully be emitted.
void	shutdown() This method is called when the KinesisConnectorRecordProcessor is shutdown.

Method Detail

emit

List<T> emit(UnmodifiableBuffer<T> buffer)
      throws IOException

Invoked when the buffer is full. This method emits the set of filtered records. It should return a list of records that were not emitted successfully. Returning Collections.emptyList() is considered a success.

Parameters:

buffer - The full buffer of records

Returns:

A list of records that failed to emit to be retried

Throws:

IOException - A failure was reached that is not recoverable, no retry will occur and the fail method will be called

fail

void fail(List<T> records)

This method defines how to handle a set of records that cannot successfully be emitted.

Parameters:

records - a list of records that were not successfully emitted

shutdown

void shutdown()

This method is called when the KinesisConnectorRecordProcessor is shutdown. It should close any existing client connections.