com.amazonaws.services.kinesis.clientlibrary.types

Class UserRecord

java.lang.Object

Record

com.amazonaws.services.kinesis.clientlibrary.types.UserRecord

public class UserRecord
extends Record

This class represents a KPL user record.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UserRecord(boolean aggregated, Record record, long subSequenceNumber, java.lang.String explicitHashKey) Create a User Record.
	UserRecord(Record record) Create a User Record from a Kinesis Record.

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.List<UserRecord>	deaggregate(java.util.List<Record> records) This method deaggregates the given list of Amazon Kinesis records into a list of KPL user records.
static java.util.List<UserRecord>	deaggregate(java.util.List<Record> records, java.math.BigInteger startingHashKey, java.math.BigInteger endingHashKey) This method deaggregates the given list of Amazon Kinesis records into a list of KPL user records.
boolean	equals(java.lang.Object obj)
java.lang.String	getExplicitHashKey()
long	getSubSequenceNumber()
int	hashCode()
boolean	isAggregated()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UserRecord

public UserRecord(Record record)

Create a User Record from a Kinesis Record.

Parameters:

record - Kinesis record

UserRecord

protected UserRecord(boolean aggregated,
          Record record,
          long subSequenceNumber,
          java.lang.String explicitHashKey)

Create a User Record.

Parameters:

aggregated - whether the record is aggregated

record - Kinesis record

subSequenceNumber - subsequence number

explicitHashKey - explicit hash key

Method Detail

getSubSequenceNumber

public long getSubSequenceNumber()

Returns:

subSequenceNumber of this UserRecord.

getExplicitHashKey

public java.lang.String getExplicitHashKey()

Returns:

explicitHashKey of this UserRecord.

isAggregated

public boolean isAggregated()

Returns:

a boolean indicating whether this UserRecord is aggregated.

toString

public java.lang.String toString()

Returns:

the String representation of this UserRecord.

hashCode

public int hashCode()

equals

public boolean equals(java.lang.Object obj)

deaggregate

public static java.util.List<UserRecord> deaggregate(java.util.List<Record> records)

This method deaggregates the given list of Amazon Kinesis records into a list of KPL user records. This method will then return the resulting list of KPL user records.

Parameters:

records - A list of Amazon Kinesis records, each possibly aggregated.

Returns:

A resulting list of deaggregated KPL user records.

deaggregate

public static java.util.List<UserRecord> deaggregate(java.util.List<Record> records,
                                     java.math.BigInteger startingHashKey,
                                     java.math.BigInteger endingHashKey)

This method deaggregates the given list of Amazon Kinesis records into a list of KPL user records. Any KPL user records whose explicit hash key or partition key falls outside the range of the startingHashKey and the endingHashKey are discarded from the resulting list. This method will then return the resulting list of KPL user records.

Parameters:

records - A list of Amazon Kinesis records, each possibly aggregated.

startingHashKey - A BigInteger representing the starting hash key that the explicit hash keys or partition keys of retained resulting KPL user records must be greater than or equal to.

endingHashKey - A BigInteger representing the ending hash key that the the explicit hash keys or partition keys of retained resulting KPL user records must be smaller than or equal to.

Returns:

A resulting list of KPL user records whose explicit hash keys or partition keys fall within the range of the startingHashKey and the endingHashKey.