com.amazonaws.services.kinesis.clientlibrary.lib.worker

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
GetRecordsCache	createRecordsFetcher(GetRecordsRetrievalStrategy getRecordsRetrievalStrategy, String shardId, IMetricsFactory metricsFactory, int maxRecords) Returns a GetRecordsCache to be used for retrieving records for a given shard.
void	setDataFetchingStrategy(DataFetchingStrategy dataFetchingStrategy) Sets the dataFetchingStrategy to determine the type of GetRecordsCache to be used.
void	setIdleMillisBetweenCalls(long idleMillisBetweenCalls) Sets the maximum idle time between two get calls.
void	setMaxByteSize(int maxByteSize) Sets the max byte size for the GetRecordsCache, before further requests are blocked.
void	setMaxPendingProcessRecordsInput(int maxPendingProcessRecordsInput) Sets the maximum number of ProcessRecordsInput objects the GetRecordsCache can hold, before further requests are blocked.
void	setMaxRecordsCount(int maxRecordsCount) Sets the max number of records for the GetRecordsCache can hold, before further requests are blocked.

Method Detail

createRecordsFetcher

GetRecordsCache createRecordsFetcher(GetRecordsRetrievalStrategy getRecordsRetrievalStrategy,
                                     String shardId,
                                     IMetricsFactory metricsFactory,
                                     int maxRecords)

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

Parameters:

getRecordsRetrievalStrategy - GetRecordsRetrievalStrategy to be used with the GetRecordsCache

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:

GetRecordsCache used to get records from Kinesis.

setMaxPendingProcessRecordsInput

void setMaxPendingProcessRecordsInput(int maxPendingProcessRecordsInput)

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

Parameters:

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

setMaxByteSize

void setMaxByteSize(int maxByteSize)

Sets the max byte size for the GetRecordsCache, 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.

setMaxRecordsCount

void setMaxRecordsCount(int maxRecordsCount)

Sets the max number of records for the GetRecordsCache 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.

setDataFetchingStrategy

void setDataFetchingStrategy(DataFetchingStrategy dataFetchingStrategy)

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

Parameters:

dataFetchingStrategy - Fetching strategy to be used

setIdleMillisBetweenCalls

void setIdleMillisBetweenCalls(long idleMillisBetweenCalls)

Sets the maximum idle time between two get calls.

Parameters:

idleMillisBetweenCalls - Sleep millis between calls.