software.amazon.kinesis.retrieval

Interface RecordsFetcherFactory

All Known Implementing Classes:

SimpleRecordsFetcherFactory

public interface RecordsFetcherFactory

This factory is used to create the records fetcher to retrieve data from Kinesis for a given shard.

Method Summary

Modifier and Type	Method and Description
RecordsPublisher	createRecordsFetcher(GetRecordsRetrievalStrategy getRecordsRetrievalStrategy, String shardId, MetricsFactory metricsFactory, int maxRecords) Returns a RecordsPublisher to be used for retrieving records for a given shard.
DataFetchingStrategy	dataFetchingStrategy()
void	dataFetchingStrategy(DataFetchingStrategy dataFetchingStrategy) Sets the dataFetchingStrategy to determine the type of RecordsPublisher to be used.
long	idleMillisBetweenCalls()
void	idleMillisBetweenCalls(long idleMillisBetweenCalls) Sets the maximum idle time between two get calls.
int	maxByteSize()
void	maxByteSize(int maxByteSize) Sets the max byte size for the RecordsPublisher, before further requests are blocked.
int	maxPendingProcessRecordsInput()
void	maxPendingProcessRecordsInput(int maxPendingProcessRecordsInput) Sets the maximum number of ProcessRecordsInput objects the RecordsPublisher can hold, before further requests are blocked.
int	maxRecordsCount()
void	maxRecordsCount(int maxRecordsCount) Sets the max number of records for the RecordsPublisher can hold, before further requests are blocked.

Method Detail

createRecordsFetcher

RecordsPublisher createRecordsFetcher(GetRecordsRetrievalStrategy getRecordsRetrievalStrategy,
                                      String shardId,
                                      MetricsFactory metricsFactory,
                                      int maxRecords)

Returns a RecordsPublisher to be used for retrieving records for a given shard.

Parameters:

getRecordsRetrievalStrategy - GetRecordsRetrievalStrategy to be used with the RecordsPublisher

shardId - ShardId of the shard that the fetcher will retrieve records for

metricsFactory - MetricsFactory used to create metricScope

maxRecords - Max number of records to be returned in a single get call

Returns:

RecordsPublisher used to get records from Kinesis.

maxPendingProcessRecordsInput

void maxPendingProcessRecordsInput(int maxPendingProcessRecordsInput)

Sets the maximum number of ProcessRecordsInput objects the RecordsPublisher can hold, before further requests are blocked.

Parameters:

maxPendingProcessRecordsInput - The maximum number of ProcessRecordsInput objects that the cache will accept before blocking.

maxPendingProcessRecordsInput

int maxPendingProcessRecordsInput()

maxByteSize

void maxByteSize(int maxByteSize)

Sets the max byte size for the RecordsPublisher, before further requests are blocked. The byte size of the cache is the sum of byte size of all the ProcessRecordsInput objects in the cache at any point of time.

Parameters:

maxByteSize - The maximum byte size for the cache before blocking.

maxByteSize

int maxByteSize()

maxRecordsCount

void maxRecordsCount(int maxRecordsCount)

Sets the max number of records for the RecordsPublisher can hold, before further requests are blocked. The records count is the sum of all records present in across all the ProcessRecordsInput objects in the cache at any point of time.

Parameters:

maxRecordsCount - The mximum number of records in the cache before blocking.

maxRecordsCount

int maxRecordsCount()

dataFetchingStrategy

void dataFetchingStrategy(DataFetchingStrategy dataFetchingStrategy)

Sets the dataFetchingStrategy to determine the type of RecordsPublisher to be used.

Parameters:

dataFetchingStrategy - Fetching strategy to be used

dataFetchingStrategy

DataFetchingStrategy dataFetchingStrategy()

idleMillisBetweenCalls

void idleMillisBetweenCalls(long idleMillisBetweenCalls)

Sets the maximum idle time between two get calls.

Parameters:

idleMillisBetweenCalls - Sleep millis between calls.

idleMillisBetweenCalls

long idleMillisBetweenCalls()