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

Interface ShardSyncStrategy

public interface ShardSyncStrategy

Facade of methods that can be invoked at different points in KCL application execution to perform certain actions related to shard-sync.

Method Summary

Modifier and Type	Method and Description
ShardSyncStrategyType	getStrategyType() Can be used to provide a custom name for the implemented strategy.
com.amazonaws.services.kinesis.clientlibrary.lib.worker.TaskResult	onFoundCompletedShard() Invoked when a completed shard is found.
com.amazonaws.services.kinesis.clientlibrary.lib.worker.TaskResult	onShardConsumerShutDown() Invoked when ShardConsumer is shutdown.
default com.amazonaws.services.kinesis.clientlibrary.lib.worker.TaskResult	onShardConsumerShutDown(List<com.amazonaws.services.kinesis.model.Shard> latestShards) Invoked when ShardConsumer is shutdown and all shards are provided.
com.amazonaws.services.kinesis.clientlibrary.lib.worker.TaskResult	onWorkerInitialization() Invoked at worker initialization
void	onWorkerShutDown() Invoked when worker is shutdown.
com.amazonaws.services.kinesis.clientlibrary.lib.worker.TaskResult	syncShards() Invoked when the KCL application wants to execute shard-sync.

Method Detail

getStrategyType

ShardSyncStrategyType getStrategyType()

Can be used to provide a custom name for the implemented strategy.

Returns:

Name of the strategy.

syncShards

com.amazonaws.services.kinesis.clientlibrary.lib.worker.TaskResult syncShards()

Invoked when the KCL application wants to execute shard-sync.

Returns:

TaskResult

onWorkerInitialization

com.amazonaws.services.kinesis.clientlibrary.lib.worker.TaskResult onWorkerInitialization()

Invoked at worker initialization

Returns:

onFoundCompletedShard

com.amazonaws.services.kinesis.clientlibrary.lib.worker.TaskResult onFoundCompletedShard()

Invoked when a completed shard is found.

Returns:

onShardConsumerShutDown

com.amazonaws.services.kinesis.clientlibrary.lib.worker.TaskResult onShardConsumerShutDown()

Invoked when ShardConsumer is shutdown.

Returns:

onShardConsumerShutDown

default com.amazonaws.services.kinesis.clientlibrary.lib.worker.TaskResult onShardConsumerShutDown(List<com.amazonaws.services.kinesis.model.Shard> latestShards)

Invoked when ShardConsumer is shutdown and all shards are provided.

Parameters:

latestShards - latest snapshot of shards to reuse

Returns:

onWorkerShutDown

void onWorkerShutDown()

Invoked when worker is shutdown.