com.amazonaws.services.kinesis.leases.impl

Class KinesisClientLease

java.lang.Object

com.amazonaws.services.kinesis.leases.impl.Lease

com.amazonaws.services.kinesis.leases.impl.KinesisClientLease

public class KinesisClientLease
extends Lease

A Lease subclass containing KinesisClientLibrary related fields for checkpoints.

Constructor Summary

Constructors

Constructor and Description
KinesisClientLease()
KinesisClientLease(KinesisClientLease other)

Method Summary

Modifier and Type	Method and Description
<T extends Lease> T	copy() Returns a deep copy of this object.
boolean	equals(Object obj)
ExtendedSequenceNumber	getCheckpoint()
Set<String>	getChildShardIds()
HashKeyRangeForLease	getHashKeyRange()
Long	getOwnerSwitchesSinceCheckpoint()
Set<String>	getParentShardIds()
ExtendedSequenceNumber	getPendingCheckpoint()
int	hashCode()
void	setCheckpoint(ExtendedSequenceNumber checkpoint) Sets checkpoint.
void	setChildShardIds(Collection<String> childShardIds) Sets childShardIds.
void	setHashKeyRange(HashKeyRangeForLease hashKeyRangeForLease) Sets hashKeyRangeForLease.
void	setOwnerSwitchesSinceCheckpoint(Long ownerSwitchesSinceCheckpoint) Sets ownerSwitchesSinceCheckpoint.
void	setParentShardIds(Collection<String> parentShardIds) Sets parentShardIds.
void	setPendingCheckpoint(ExtendedSequenceNumber pendingCheckpoint) Sets pending checkpoint.
<T extends Lease> void	update(T other) Updates this Lease's mutable, application-specific fields based on the passed-in lease object.

Methods inherited from class com.amazonaws.services.kinesis.leases.impl.Lease

getConcurrencyToken, getLastCounterIncrementNanos, getLeaseCounter, getLeaseKey, getLeaseOwner, isExpired, setConcurrencyToken, setLastCounterIncrementNanos, setLeaseCounter, setLeaseKey, setLeaseOwner, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

KinesisClientLease

public KinesisClientLease()

KinesisClientLease

public KinesisClientLease(KinesisClientLease other)

Method Detail

update

public <T extends Lease> void update(T other)

Updates this Lease's mutable, application-specific fields based on the passed-in lease object. Does not update fields that are internal to the leasing library (leaseKey, leaseOwner, leaseCounter).

Overrides:

update in class Lease

getCheckpoint

public ExtendedSequenceNumber getCheckpoint()

Returns:

most recently application-supplied checkpoint value. During fail over, the new worker will pick up after the old worker's last checkpoint.

getPendingCheckpoint

public ExtendedSequenceNumber getPendingCheckpoint()

Returns:

pending checkpoint, possibly null.

getOwnerSwitchesSinceCheckpoint

public Long getOwnerSwitchesSinceCheckpoint()

Returns:

count of distinct lease holders between checkpoints.

getParentShardIds

public Set<String> getParentShardIds()

Returns:

shardIds that parent this lease. Used for resharding.

getChildShardIds

public Set<String> getChildShardIds()

Returns:

shardIds for the child shards of the current shard. Used for resharding.

getHashKeyRange

public HashKeyRangeForLease getHashKeyRange()

Returns:

hash key range that this lease covers.

setCheckpoint

public void setCheckpoint(ExtendedSequenceNumber checkpoint)

Sets checkpoint.

Parameters:

checkpoint - may not be null

setPendingCheckpoint

public void setPendingCheckpoint(ExtendedSequenceNumber pendingCheckpoint)

Sets pending checkpoint.

Parameters:

pendingCheckpoint - can be null

setOwnerSwitchesSinceCheckpoint

public void setOwnerSwitchesSinceCheckpoint(Long ownerSwitchesSinceCheckpoint)

Sets ownerSwitchesSinceCheckpoint.

Parameters:

ownerSwitchesSinceCheckpoint - may not be null

setParentShardIds

public void setParentShardIds(Collection<String> parentShardIds)

Sets parentShardIds.

Parameters:

parentShardIds - may not be null

setChildShardIds

public void setChildShardIds(Collection<String> childShardIds)

Sets childShardIds.

Parameters:

childShardIds - may not be null

setHashKeyRange

public void setHashKeyRange(HashKeyRangeForLease hashKeyRangeForLease)

Sets hashKeyRangeForLease.

Parameters:

hashKeyRangeForLease - may not be null

hashCode

public int hashCode()

Overrides:

hashCode in class Lease

equals

public boolean equals(Object obj)

Overrides:

equals in class Lease

copy

public <T extends Lease> T copy()

Returns a deep copy of this object. Type-unsafe - there aren't good mechanisms for copy-constructing generics.

Overrides:

copy in class Lease

Returns:

A deep copy of this object.