com.amazonaws.services.kinesis.leases.interfaces

Interface IKinesisClientLeaseManager

All Superinterfaces:

ILeaseManager<KinesisClientLease>

All Known Implementing Classes:

KinesisClientLeaseManager

public interface IKinesisClientLeaseManager
extends ILeaseManager<KinesisClientLease>

A decoration of ILeaseManager that adds methods to get/update checkpoints.

Method Summary

Methods

Modifier and Type	Method and Description
ExtendedSequenceNumber	getCheckpoint(java.lang.String shardId) Gets the current checkpoint of the shard.

Methods inherited from interface com.amazonaws.services.kinesis.leases.interfaces.ILeaseManager

createLeaseIfNotExists, createLeaseTableIfNotExists, deleteAll, deleteLease, evictLease, getLease, leaseTableExists, listLeases, renewLease, takeLease, updateLease, waitUntilLeaseTableExists

Method Detail

getCheckpoint

ExtendedSequenceNumber getCheckpoint(java.lang.String shardId)
                                     throws ProvisionedThroughputException,
                                            InvalidStateException,
                                            DependencyException

Gets the current checkpoint of the shard. This is useful in the resharding use case where we will wait for the parent shard to complete before starting on the records from a child shard.

Parameters:

shardId - Checkpoint of this shard will be returned

Returns:

Checkpoint of this shard, or null if the shard record doesn't exist.

Throws:

ProvisionedThroughputException - if DynamoDB update fails due to lack of capacity

InvalidStateException - if lease table does not exist

DependencyException - if DynamoDB update fails in an unexpected way