software.amazon.kinesis.leases

Class ShardInfo

java.lang.Object

software.amazon.kinesis.leases.ShardInfo

public class ShardInfo
extends Object

Used to pass shard related info among different classes and as a key to the map of shard consumers.

Constructor Summary

Constructors

Constructor and Description
ShardInfo(String shardId, String concurrencyToken, Collection<String> parentShardIds, ExtendedSequenceNumber checkpoint) Creates a new ShardInfo object.
ShardInfo(String shardId, String concurrencyToken, Collection<String> parentShardIds, ExtendedSequenceNumber checkpoint, String streamIdentifierSer) Creates a new ShardInfo object that has an option to pass a serialized streamIdentifier.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) This method assumes parentShardIds is ordered.
static String	getLeaseKey(ShardInfo shardInfo) Utility method to derive lease key from ShardInfo.
static String	getLeaseKey(ShardInfo shardInfo, String shardIdOverride) Utility method to derive lease key from ShardInfo and shardId to override.
int	hashCode()
boolean	isCompleted() Whether the shard has been completely processed or not.
List<String>	parentShardIds() A list of shards that are parents of this shard.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ShardInfo

public ShardInfo(@NonNull
                 String shardId,
                 String concurrencyToken,
                 Collection<String> parentShardIds,
                 ExtendedSequenceNumber checkpoint)

Creates a new ShardInfo object. The checkpoint is not part of the equality, but is used for debugging output.

Parameters:

shardId - Kinesis shardId that this will be about

concurrencyToken - Used to differentiate between lost and reclaimed leases

parentShardIds - Parent shards of the shard identified by Kinesis shardId

checkpoint - the latest checkpoint from lease

ShardInfo

public ShardInfo(@NonNull
                 String shardId,
                 String concurrencyToken,
                 Collection<String> parentShardIds,
                 ExtendedSequenceNumber checkpoint,
                 String streamIdentifierSer)

Creates a new ShardInfo object that has an option to pass a serialized streamIdentifier. The checkpoint is not part of the equality, but is used for debugging output.

Parameters:

shardId -

concurrencyToken -

parentShardIds -

checkpoint -

streamIdentifierSer -

Method Detail

parentShardIds

public List<String> parentShardIds()

A list of shards that are parents of this shard. This may be empty if the shard has no parents.

Returns:

a list of shardId's that are parents of this shard, or empty if the shard has no parents.

isCompleted

public boolean isCompleted()

Whether the shard has been completely processed or not.

Returns:

completion status of the shard

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

This method assumes parentShardIds is ordered. The Worker.cleanupShardConsumers() method relies on this method returning true for ShardInfo objects which may have been instantiated with parentShardIds in a different order (and rest of the fields being the equal). For example shardInfo1.equals(shardInfo2) should return true with shardInfo1 and shardInfo2 defined as follows. ShardInfo shardInfo1 = new ShardInfo(shardId1, concurrencyToken1, Arrays.asList("parent1", "parent2")); ShardInfo shardInfo2 = new ShardInfo(shardId1, concurrencyToken1, Arrays.asList("parent2", "parent1"));

Overrides:

equals in class Object

getLeaseKey

public static String getLeaseKey(ShardInfo shardInfo)

Utility method to derive lease key from ShardInfo.

Parameters:

shardInfo -

Returns:

lease key

getLeaseKey

public static String getLeaseKey(ShardInfo shardInfo,
                                 String shardIdOverride)

Utility method to derive lease key from ShardInfo and shardId to override.

Parameters:

shardInfo -

shardIdOverride -

Returns:

lease key