software.amazon.kinesis.retrieval.polling

Class KinesisDataFetcher

java.lang.Object

software.amazon.kinesis.retrieval.polling.KinesisDataFetcher

public class KinesisDataFetcher
extends Object

Used to get data from Amazon Kinesis. Tracks iterator state internally.

Constructor Summary

Constructors

Constructor and Description
KinesisDataFetcher(software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient, String streamName, String shardId, int maxRecords, MetricsFactory metricsFactory) Deprecated.
KinesisDataFetcher(software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient, String streamName, String shardId, int maxRecords, MetricsFactory metricsFactory, Duration maxFutureWait)

Method Summary

Modifier and Type	Method and Description
void	advanceIteratorTo(String sequenceNumber, InitialPositionInStreamExtended initialPositionInStream) Advances this KinesisDataFetcher's internal iterator to be at the passed-in sequence number.
DataFetcherResult	getRecords() Get records from the current position in the stream (up to maxRecords).
void	initialize(ExtendedSequenceNumber initialCheckpoint, InitialPositionInStreamExtended initialPositionInStream)
void	initialize(String initialCheckpoint, InitialPositionInStreamExtended initialPositionInStream) Initializes this KinesisDataFetcher's iterator based on the checkpointed sequence number.
void	resetIterator(String shardIterator, String sequenceNumber, InitialPositionInStreamExtended initialPositionInStream)
void	restartIterator() Gets a new iterator from the last known sequence number i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

KinesisDataFetcher

@Deprecated
public KinesisDataFetcher(software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient,
                                      String streamName,
                                      String shardId,
                                      int maxRecords,
                                      MetricsFactory metricsFactory)

Deprecated.

KinesisDataFetcher

public KinesisDataFetcher(software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient,
                          String streamName,
                          String shardId,
                          int maxRecords,
                          MetricsFactory metricsFactory,
                          Duration maxFutureWait)

Method Detail

getRecords

public DataFetcherResult getRecords()

Get records from the current position in the stream (up to maxRecords).

Returns:

list of records of up to maxRecords size

initialize

public void initialize(String initialCheckpoint,
                       InitialPositionInStreamExtended initialPositionInStream)

Initializes this KinesisDataFetcher's iterator based on the checkpointed sequence number.

Parameters:

initialCheckpoint - Current checkpoint sequence number for this shard.

initialPositionInStream - The initialPositionInStream.

initialize

public void initialize(ExtendedSequenceNumber initialCheckpoint,
                       InitialPositionInStreamExtended initialPositionInStream)

advanceIteratorTo

public void advanceIteratorTo(String sequenceNumber,
                              InitialPositionInStreamExtended initialPositionInStream)

Advances this KinesisDataFetcher's internal iterator to be at the passed-in sequence number.

Parameters:

sequenceNumber - advance the iterator to the record at this sequence number.

initialPositionInStream - The initialPositionInStream.

restartIterator

public void restartIterator()

Gets a new iterator from the last known sequence number i.e. the sequence number of the last record from the last records call.

resetIterator

public void resetIterator(String shardIterator,
                          String sequenceNumber,
                          InitialPositionInStreamExtended initialPositionInStream)