com.amazonaws.services.kinesis.clientlibrary.proxies

Interface IKinesisProxy

All Known Subinterfaces:

IKinesisProxyExtended

All Known Implementing Classes:

KinesisProxy, MetricsCollectingKinesisProxyDecorator

public interface IKinesisProxy

Kinesis proxy interface. Operates on a single stream (set up at initialization).

Method Summary

Modifier and Type	Method and Description
com.amazonaws.services.kinesis.model.GetRecordsResult	get(String shardIterator, int maxRecords) Get records from stream.
Set<String>	getAllShardIds() Fetch the shardIds of all shards in the stream.
String	getIterator(String shardId, Date timestamp) Fetch a shard iterator from the specified position in the shard.
String	getIterator(String shardId, String iteratorEnum) Fetch a shard iterator from the specified position in the shard.
String	getIterator(String shardId, String iteratorEnum, String sequenceNumber) Fetch a shard iterator from the specified position in the shard.
List<com.amazonaws.services.kinesis.model.Shard>	getShardList() Fetch all the shards defined for the stream (e.g.
List<com.amazonaws.services.kinesis.model.Shard>	getShardListWithFilter(com.amazonaws.services.kinesis.model.ShardFilter shardFilter) Fetch a subset shards defined for the stream using a filter on the ListShards API.
com.amazonaws.services.kinesis.model.DescribeStreamResult	getStreamInfo(String startShardId) Deprecated. Going forward this method is being deprecated. This method uses DescribeStream call, which is throttled at 10 calls per account by default. If possible try to use ListShards call available in the client, or use the getShardList or getAllShards to get shard info. To make DescribeStream calls, use the AmazonKinesis client directly instead of using KinesisProxy. This method will be removed in the next major/minor release.
com.amazonaws.services.kinesis.model.PutRecordResult	put(String sequenceNumberForOrdering, String explicitHashKey, String partitionKey, ByteBuffer data)
ShardClosureVerificationResponse	verifyShardClosure(String shardId) Used to verify during ShardConsumer shutdown if the provided shardId is for a shard that has been closed.

Method Detail

get

com.amazonaws.services.kinesis.model.GetRecordsResult get(String shardIterator,
                                                          int maxRecords)
                                                   throws com.amazonaws.services.kinesis.model.ResourceNotFoundException,
                                                          com.amazonaws.services.kinesis.model.InvalidArgumentException,
                                                          com.amazonaws.services.kinesis.model.ExpiredIteratorException

Get records from stream.

Parameters:

shardIterator - Fetch data records using this shard iterator

maxRecords - Fetch at most this many records

Returns:

List of data records from Kinesis.

Throws:

com.amazonaws.services.kinesis.model.InvalidArgumentException - Invalid input parameters

com.amazonaws.services.kinesis.model.ResourceNotFoundException - The Kinesis stream or shard was not found

com.amazonaws.services.kinesis.model.ExpiredIteratorException - The iterator has expired

getStreamInfo

@Deprecated
com.amazonaws.services.kinesis.model.DescribeStreamResult getStreamInfo(String startShardId)
                                                                             throws com.amazonaws.services.kinesis.model.ResourceNotFoundException

Deprecated. Going forward this method is being deprecated. This method uses DescribeStream call, which is throttled at 10 calls per account by default. If possible try to use ListShards call available in the client, or use the getShardList or getAllShards to get shard info. To make DescribeStream calls, use the AmazonKinesis client directly instead of using KinesisProxy. This method will be removed in the next major/minor release.

Fetch information about stream. Useful for fetching the list of shards in a stream.

Parameters:

startShardId - exclusive start shardId - used when paginating the list of shards.

Returns:

DescribeStreamOutput object containing a description of the stream.

Throws:

com.amazonaws.services.kinesis.model.ResourceNotFoundException - The Kinesis stream was not found

getAllShardIds

Set<String> getAllShardIds()
                    throws com.amazonaws.services.kinesis.model.ResourceNotFoundException

Fetch the shardIds of all shards in the stream.

Returns:

Set of all shardIds

Throws:

com.amazonaws.services.kinesis.model.ResourceNotFoundException - If the specified Kinesis stream was not found

getShardList

List<com.amazonaws.services.kinesis.model.Shard> getShardList()
                                                       throws com.amazonaws.services.kinesis.model.ResourceNotFoundException

Fetch all the shards defined for the stream (e.g. obtained via calls to the DescribeStream API). This can be used to discover new shards and consume data from them.

Returns:

List of all shards in the Kinesis stream.

Throws:

com.amazonaws.services.kinesis.model.ResourceNotFoundException - The Kinesis stream was not found.

getShardListWithFilter

List<com.amazonaws.services.kinesis.model.Shard> getShardListWithFilter(com.amazonaws.services.kinesis.model.ShardFilter shardFilter)
                                                                 throws com.amazonaws.services.kinesis.model.ResourceNotFoundException

Fetch a subset shards defined for the stream using a filter on the ListShards API. This can be used to discover new shards and consume data from them, while limiting the total number of shards returned for performance or efficiency reasons.

Parameters:

shardFilter - currently supported filter types are AT_LATEST, AT_TRIM_HORIZON, AT_TIMESTAMP.

Returns:

List of all shards in the Kinesis stream.

Throws:

com.amazonaws.services.kinesis.model.ResourceNotFoundException - The Kinesis stream was not found.

verifyShardClosure

ShardClosureVerificationResponse verifyShardClosure(String shardId)

Used to verify during ShardConsumer shutdown if the provided shardId is for a shard that has been closed.

Parameters:

shardId - Id of the shard that needs to be verified.

Returns:

an Object of type ShardClosureVerificationResponse.

getIterator

String getIterator(String shardId,
                   String iteratorEnum,
                   String sequenceNumber)
            throws com.amazonaws.services.kinesis.model.ResourceNotFoundException,
                   com.amazonaws.services.kinesis.model.InvalidArgumentException

Fetch a shard iterator from the specified position in the shard. This is to fetch a shard iterator for ShardIteratorType AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER which requires the starting sequence number. NOTE: Currently this method continues to fetch iterators for ShardIteratorTypes TRIM_HORIZON, LATEST, AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER. But this behavior will change in the next release, after which this method will only serve AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER ShardIteratorTypes. We recommend users who call this method directly to use the appropriate getIterator method based on the ShardIteratorType.

Parameters:

shardId - Shard id

iteratorEnum - one of: TRIM_HORIZON, LATEST, AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER

sequenceNumber - the sequence number - must be null unless iteratorEnum is AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER

Returns:

shard iterator which can be used to read data from Kinesis.

Throws:

com.amazonaws.services.kinesis.model.ResourceNotFoundException - The Kinesis stream or shard was not found

com.amazonaws.services.kinesis.model.InvalidArgumentException - Invalid input parameters

getIterator

String getIterator(String shardId,
                   String iteratorEnum)
            throws com.amazonaws.services.kinesis.model.ResourceNotFoundException,
                   com.amazonaws.services.kinesis.model.InvalidArgumentException

Fetch a shard iterator from the specified position in the shard. This is to fetch a shard iterator for ShardIteratorType LATEST or TRIM_HORIZON which doesn't require a starting sequence number.

Parameters:

shardId - Shard id

iteratorEnum - Either TRIM_HORIZON or LATEST.

Returns:

shard iterator which can be used to read data from Kinesis.

Throws:

com.amazonaws.services.kinesis.model.ResourceNotFoundException - The Kinesis stream or shard was not found

com.amazonaws.services.kinesis.model.InvalidArgumentException - Invalid input parameters

getIterator

String getIterator(String shardId,
                   Date timestamp)
            throws com.amazonaws.services.kinesis.model.ResourceNotFoundException,
                   com.amazonaws.services.kinesis.model.InvalidArgumentException

Fetch a shard iterator from the specified position in the shard. This is to fetch a shard iterator for ShardIteratorType AT_TIMESTAMP which requires the timestamp field.

Parameters:

shardId - Shard id

timestamp - The timestamp.

Returns:

shard iterator which can be used to read data from Kinesis.

Throws:

com.amazonaws.services.kinesis.model.ResourceNotFoundException - The Kinesis stream or shard was not found

com.amazonaws.services.kinesis.model.InvalidArgumentException - Invalid input parameters

put

com.amazonaws.services.kinesis.model.PutRecordResult put(String sequenceNumberForOrdering,
                                                         String explicitHashKey,
                                                         String partitionKey,
                                                         ByteBuffer data)
                                                  throws com.amazonaws.services.kinesis.model.ResourceNotFoundException,
                                                         com.amazonaws.services.kinesis.model.InvalidArgumentException

Parameters:

sequenceNumberForOrdering - (optional) used for record ordering

explicitHashKey - optionally supplied transformation of partitionkey

partitionKey - for this record

data - payload

Returns:

PutRecordResult (contains the Kinesis sequence number of the record).

Throws:

com.amazonaws.services.kinesis.model.ResourceNotFoundException - The Kinesis stream was not found.

com.amazonaws.services.kinesis.model.InvalidArgumentException - InvalidArgumentException.