de.otto.synapse.endpoint.receiver.aws

Class KinesisShardIterator

java.lang.Object

de.otto.synapse.endpoint.receiver.aws.KinesisShardIterator

public class KinesisShardIterator
extends java.lang.Object

A helper class used to retrieve and traverse Kinesis Shards.

Caution: Creating a KinesisShardIterator is an expensive operation, so instances should be reused and messages should be read continuously using by calling next() should be preferred. Creating a KinesisShardIterator too often may result in a ProvisionedThroughputExceededException coming from the Amazon Kinesis SDK as described here.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	FETCH_RECORDS_LIMIT
static java.lang.String	POISON_SHARD_ITER

Constructor Summary

Constructors

Constructor and Description
KinesisShardIterator(software.amazon.awssdk.services.kinesis.KinesisClient kinesisClient, java.lang.String channelName, de.otto.synapse.channel.ShardPosition shardPosition)
KinesisShardIterator(software.amazon.awssdk.services.kinesis.KinesisClient kinesisClient, java.lang.String channelName, de.otto.synapse.channel.ShardPosition shardPosition, int fetchRecordLimit)

Method Summary

Modifier and Type	Method and Description
int	getFetchRecordLimit()
java.lang.String	getId()
de.otto.synapse.channel.ShardPosition	getShardPosition()
KinesisShardResponse	next()
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

POISON_SHARD_ITER

public static final java.lang.String POISON_SHARD_ITER

See Also:

Constant Field Values

FETCH_RECORDS_LIMIT

public static final java.lang.Integer FETCH_RECORDS_LIMIT

Constructor Detail

KinesisShardIterator

public KinesisShardIterator(@Nonnull
                            software.amazon.awssdk.services.kinesis.KinesisClient kinesisClient,
                            @Nonnull
                            java.lang.String channelName,
                            @Nonnull
                            de.otto.synapse.channel.ShardPosition shardPosition)

KinesisShardIterator

public KinesisShardIterator(@Nonnull
                            software.amazon.awssdk.services.kinesis.KinesisClient kinesisClient,
                            @Nonnull
                            java.lang.String channelName,
                            @Nonnull
                            de.otto.synapse.channel.ShardPosition shardPosition,
                            int fetchRecordLimit)

Method Detail

getId

public java.lang.String getId()

getShardPosition

@Nonnull
public de.otto.synapse.channel.ShardPosition getShardPosition()

getFetchRecordLimit

public int getFetchRecordLimit()

stop

public void stop()

next

public KinesisShardResponse next()