com.amazonaws.services.kinesis.clientlibrary.lib.worker.ShardSyncStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of amazon-kinesis-client Show documentation

The Amazon Kinesis Client Library for Java enables Java developers to easily consume and process data from Amazon Kinesis.

There is a newer version: 1.15.2

Show newest version

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

import com.amazonaws.services.kinesis.model.Shard;

import java.util.List;

/**
 * Facade of methods that can be invoked at different points
 * in KCL application execution to perform certain actions related to shard-sync.
 */
public interface ShardSyncStrategy {

    /**
     * Can be used to provide a custom name for the implemented strategy.
     *
     * @return Name of the strategy.
     */
    ShardSyncStrategyType getStrategyType();

    /**
     * Invoked when the KCL application wants to execute shard-sync.
     *
     * @return TaskResult
     */
    TaskResult syncShards();

    /**
     * Invoked at worker initialization
     *
     * @return
     */
    TaskResult onWorkerInitialization();

    /**
     * Invoked when a completed shard is found.
     *
     * @return
     */
    TaskResult onFoundCompletedShard();

    /**
     * Invoked when ShardConsumer is shutdown.
     *
     * @return
     */
    TaskResult onShardConsumerShutDown();

    /**
     * Invoked when ShardConsumer is shutdown and all shards are provided.
     *
     * @param latestShards latest snapshot of shards to reuse
     * @return
     */
    default TaskResult onShardConsumerShutDown(List latestShards) {
        return onShardConsumerShutDown();
    }

    /**
     * Invoked when worker is shutdown.
     */
    void onWorkerShutDown();
}