com.amazonaws.services.kinesisanalytics.flink.connectors.producer

Interface IProducer<O,R>

All Known Implementing Classes:

FirehoseProducer

public interface IProducer<O,R>

Interface responsible for sending data a specific sink

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<O>	addUserRecord(R record) This method should send data to an specific destination.
com.google.common.util.concurrent.ListenableFuture<O>	addUserRecord(R record, long operationTimeoutInMillis) This method should send data to an specific destination
void	destroy() Destroy and release any used resource.
void	flush() This method flushes the buffer immediately.
void	flushSync() Performs a synchronous flush on the buffer waiting until the whole buffer is drained.
int	getOutstandingRecordsCount() Should return the number of outstanding records if the producer implements buffering.
boolean	isDestroyed() Returns whether the producer has been destroyed or not
boolean	isFlushFailed() A flag representing whether the flush has failed or not.

Method Detail

addUserRecord

com.google.common.util.concurrent.ListenableFuture<O> addUserRecord(R record)
                                                             throws Exception

This method should send data to an specific destination.

Parameters:

record - the type of data to be sent

Returns:

a ListenableFuture with the result for the operation.

Throws:

Exception

addUserRecord

com.google.common.util.concurrent.ListenableFuture<O> addUserRecord(R record,
                                                                    long operationTimeoutInMillis)
                                                             throws Exception

This method should send data to an specific destination

Parameters:

record - the type of data to be sent

operationTimeoutInMillis - the expected operation timeout

Returns:

a ListenableFuture with the result for the operation.

Throws:

Exception

destroy

void destroy()
      throws Exception

Destroy and release any used resource.

Throws:

Exception

isDestroyed

boolean isDestroyed()

Returns whether the producer has been destroyed or not

Returns:

getOutstandingRecordsCount

int getOutstandingRecordsCount()

Should return the number of outstanding records if the producer implements buffering.

Returns:

an integer with the number of outstanding records.

flush

void flush()

This method flushes the buffer immediately.

flushSync

void flushSync()

Performs a synchronous flush on the buffer waiting until the whole buffer is drained.

isFlushFailed

boolean isFlushFailed()

A flag representing whether the flush has failed or not.

Returns:

boolean representing whether the success of failure of flush buffer operation.