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

Interface Summary

Interface	Description
DataFetcherResult	Represents the result from the DataFetcher, and allows the receiver to accept a result
GetRecordsCache	This class is used as a cache for Prefetching data from Kinesis.
GetRecordsRetrievalStrategy	Represents a strategy to retrieve records from Kinesis.
GetRecordsRetriever	This class uses the GetRecordsRetrievalStrategy class to retrieve the next set of records and update the cache.
IDataFetcher
IPeriodicShardSyncManager
IShardConsumer
IShardConsumerFactory
ITask	Interface for shard processing tasks.
KinesisConsumerStates.ConsumerState	Represents a the current state of the consumer.
LeaderDecider	Used in conjunction with periodic shard sync.
LeaseCleanupValidator	Deprecated
RecordsFetcherFactory	This factory is used to create the records fetcher to retrieve data from Kinesis for a given shard.
ShardPrioritization	Provides logic to prioritize or filter shards before their execution.
ShardSyncer
ShardSyncStrategy	Facade of methods that can be invoked at different points in KCL application execution to perform certain actions related to shard-sync.
ShutdownNotification	A shutdown request to the ShardConsumer
WorkerStateChangeListener	A listener for callbacks on changes worker state

Class Summary

Class	Description
AsynchronousGetRecordsRetrievalStrategy
BlockingGetRecordsCache	This is the BlockingGetRecordsCache class.
BlockOnParentShardTask	Task to block until processing of all data records in the parent shard(s) is completed.
DoesNothingPreparedCheckpointer	A special IPreparedCheckpointer that does nothing, which can be used when preparing a checkpoint at the current checkpoint sequence number where it is never necessary to do another checkpoint.
InitializeTask	Task for initializing shard position and invoking the RecordProcessor initialize() API.
InitialPositionInStreamExtended	Class that houses the entities needed to specify the position in the stream from where a new application should start.
IPeriodicShardSyncManager.ShardSyncResponse
KinesisClientLibConfiguration	Configuration for the Amazon Kinesis Client Library.
KinesisClientLibLeaseCoordinator	This class is used to coordinate/manage leases owned by this worker process and to get/set checkpoints.
KinesisConsumerStates	Top level container for all the possible states a KinesisShardConsumer can be in.
KinesisConsumerStates.InitializingState	This state is responsible for initializing the record processor with the shard information.
KinesisDataFetcher	Used to get data from Amazon Kinesis.
KinesisShardConsumer	Responsible for consuming data records of a (specified) shard.
KinesisShardConsumerFactory
KinesisShutdownTask	Task for invoking the RecordProcessor shutdown() callback.
MetricsCollectingTaskDecorator	Decorates an ITask and reports metrics about its timing and success/failure.
NoOpShardPrioritization	Shard Prioritization that returns the same original list of shards without any modifications.
NoOpWorkerStateChangeListener
ParentsFirstShardPrioritization	Deprecated
PrefetchGetRecordsCache	This is the prefetch caching class, this class spins up a thread if prefetching is enabled.
PreparedCheckpointer	Objects of this class are prepared to checkpoint at a specific sequence number.
ProcessTask	Task for fetching data records and invoking processRecords() on the record processor instance.
RecordProcessorCheckpointer	This class is used to enable RecordProcessors to checkpoint their progress.
SequenceNumberValidator	This class provides some methods for validating sequence numbers.
ShardInfo	Used to pass shard related info among different classes and as a key to the map of shard consumers.
ShardSyncTask	This task syncs leases/activies with shards of the stream.
ShutdownNotificationTask	Notifies record processor of incoming shutdown request, and gives them a chance to checkpoint.
SimpleRecordsFetcherFactory
StreamConfig	Used to capture stream configuration and pass it along.
SynchronousGetRecordsRetrievalStrategy
TaskResult	Used to capture information from a task that we want to communicate back to the higher layer.
Worker	Worker is the high level class that Kinesis applications use to start processing data.
Worker.Builder	Builder to construct a Worker instance.

Enum Summary

Enum	Description
DataFetchingStrategy
InitialPositionInStream	Used to specify the position in the stream where a new application should start from.
IShardConsumer.TaskOutcome
KinesisConsumerStates.ShardConsumerState	Enumerates processing states when working on a shard.
ShardSyncStrategyType	Types of ShardSyncStrategy} implemented in KCL.
ShutdownReason	Reason the RecordProcessor is being shutdown.
TaskType	Enumerates types of tasks executed as part of processing a shard.
WorkerStateChangeListener.WorkerState