software.amazon.kinesis.retrieval.kpl

Class ExtendedSequenceNumber

java.lang.Object

software.amazon.kinesis.retrieval.kpl.ExtendedSequenceNumber

All Implemented Interfaces:

Comparable<ExtendedSequenceNumber>

public class ExtendedSequenceNumber
extends Object
implements Comparable<ExtendedSequenceNumber>

Represents a two-part sequence number for records aggregated by the Kinesis Producer Library.

The KPL combines multiple user records into a single Kinesis record. Each user record therefore has an integer sub-sequence number, in addition to the regular sequence number of the Kinesis record. The sub-sequence number is used to checkpoint within an aggregated record.

Author:

daphnliu

Field Summary

Fields

Modifier and Type	Field and Description
static ExtendedSequenceNumber	AT_TIMESTAMP Special value for AT_TIMESTAMP.
static ExtendedSequenceNumber	LATEST Special value for LATEST.
static ExtendedSequenceNumber	SHARD_END Special value for SHARD_END.
static ExtendedSequenceNumber	TRIM_HORIZON Special value for TRIM_HORIZON.

Constructor Summary

Constructors

Constructor and Description
ExtendedSequenceNumber(String sequenceNumber) Construct an ExtendedSequenceNumber.
ExtendedSequenceNumber(String sequenceNumber, Long subSequenceNumber) Construct an ExtendedSequenceNumber.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ExtendedSequenceNumber extendedSequenceNumber) Compares this with another ExtendedSequenceNumber using these rules.
boolean	equals(Object obj)
int	hashCode()
boolean	isShardEnd()
String	sequenceNumber()
long	subSequenceNumber()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LATEST

public static final ExtendedSequenceNumber LATEST

Special value for LATEST.

SHARD_END

public static final ExtendedSequenceNumber SHARD_END

Special value for SHARD_END.

TRIM_HORIZON

public static final ExtendedSequenceNumber TRIM_HORIZON

Special value for TRIM_HORIZON.

AT_TIMESTAMP

public static final ExtendedSequenceNumber AT_TIMESTAMP

Special value for AT_TIMESTAMP.

Constructor Detail

ExtendedSequenceNumber

public ExtendedSequenceNumber(String sequenceNumber)

Construct an ExtendedSequenceNumber. The sub-sequence number defaults to 0.

Parameters:

sequenceNumber - Sequence number of the Kinesis record

ExtendedSequenceNumber

public ExtendedSequenceNumber(String sequenceNumber,
                              Long subSequenceNumber)

Construct an ExtendedSequenceNumber.

Parameters:

sequenceNumber - Sequence number of the Kinesis record

subSequenceNumber - Sub-sequence number of the user record within the Kinesis record

Method Detail

compareTo

public int compareTo(ExtendedSequenceNumber extendedSequenceNumber)

Compares this with another ExtendedSequenceNumber using these rules. SHARD_END is considered greatest TRIM_HORIZON, LATEST and AT_TIMESTAMP are considered less than sequence numbers sequence numbers are given their big integer value

Specified by:

compareTo in interface Comparable<ExtendedSequenceNumber>

Parameters:

extendedSequenceNumber - The ExtendedSequenceNumber to compare against

Returns:

returns negative/0/positive if this is less than/equal to/greater than extendedSequenceNumber

sequenceNumber

public String sequenceNumber()

Returns:

The sequence number of the Kinesis record.

subSequenceNumber

public long subSequenceNumber()

Returns:

The sub-sequence number of the user record within the enclosing Kinesis record.

isShardEnd

public boolean isShardEnd()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object