software.amazon.kinesis.retrieval.polling

Class KinesisDataFetcher

java.lang.Object

software.amazon.kinesis.retrieval.polling.KinesisDataFetcher

All Implemented Interfaces:

DataFetcher

public class KinesisDataFetcher
extends Object
implements DataFetcher

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, DataFetcherProviderConfig kinesisDataFetcherProviderConfig) Constructs KinesisDataFetcher.
KinesisDataFetcher(software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient, String streamName, String shardId, int maxRecords, MetricsFactory metricsFactory) Deprecated.

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.
software.amazon.awssdk.services.kinesis.model.GetRecordsRequest	getGetRecordsRequest(String nextIterator) Retrieves the next get records request based on the current iterator.
software.amazon.awssdk.services.kinesis.model.GetRecordsResponse	getGetRecordsResponse(software.amazon.awssdk.services.kinesis.model.GetRecordsRequest request) Retrieves the response based on the request.
String	getNextIterator(software.amazon.awssdk.services.kinesis.model.GetShardIteratorRequest request) Gets the next iterator based on the request.
DataFetcherResult	getRecords() Get records from the current position in the stream (up to maxRecords).
software.amazon.awssdk.services.kinesis.model.GetRecordsResponse	getRecords(String nextIterator) Gets the next set of records based on the iterator.
void	initialize(ExtendedSequenceNumber initialCheckpoint, InitialPositionInStreamExtended initialPositionInStream) Initializes this KinesisDataFetcher's iterator based on the checkpointed sequence number as an ExtendedSequenceNumber.
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) Resets the iterator by setting shardIterator, sequenceNumber and the position in the stream.
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

Methods inherited from interface software.amazon.kinesis.retrieval.polling.DataFetcher

getStreamIdentifier, isShardEndReached

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,
                          DataFetcherProviderConfig kinesisDataFetcherProviderConfig)

Constructs KinesisDataFetcher.

Parameters:

kinesisClient -

kinesisDataFetcherProviderConfig -

Method Detail

getRecords

public DataFetcherResult getRecords()

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

Specified by:

getRecords in interface DataFetcher

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.

Specified by:

initialize in interface DataFetcher

Parameters:

initialCheckpoint - Current checkpoint sequence number for this shard.

initialPositionInStream - The initialPositionInStream.

initialize

public void initialize(ExtendedSequenceNumber initialCheckpoint,
                       InitialPositionInStreamExtended initialPositionInStream)

Description copied from interface: DataFetcher

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

Specified by:

initialize in interface DataFetcher

Parameters:

initialCheckpoint - Current checkpoint sequence number for this shard.

initialPositionInStream - The initialPositionInStream.

advanceIteratorTo

public void advanceIteratorTo(String sequenceNumber,
                              InitialPositionInStreamExtended initialPositionInStream)

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

Specified by:

advanceIteratorTo in interface DataFetcher

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.

Specified by:

restartIterator in interface DataFetcher

resetIterator

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

Description copied from interface: DataFetcher

Resets the iterator by setting shardIterator, sequenceNumber and the position in the stream.

Specified by:

resetIterator in interface DataFetcher

Parameters:

shardIterator - set the current shard iterator.

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

initialPositionInStream - the current position in the stream to reset the iterator to.

getGetRecordsResponse

public software.amazon.awssdk.services.kinesis.model.GetRecordsResponse getGetRecordsResponse(software.amazon.awssdk.services.kinesis.model.GetRecordsRequest request)
                                                                                       throws ExecutionException,
                                                                                              InterruptedException,
                                                                                              TimeoutException

Description copied from interface: DataFetcher

Retrieves the response based on the request.

Specified by:

getGetRecordsResponse in interface DataFetcher

Parameters:

request - the current get records request used to receive a response.

Returns:

GetRecordsResponse response for getRecords

Throws:

ExecutionException

InterruptedException

TimeoutException

getGetRecordsRequest

public software.amazon.awssdk.services.kinesis.model.GetRecordsRequest getGetRecordsRequest(String nextIterator)

Description copied from interface: DataFetcher

Retrieves the next get records request based on the current iterator.

Specified by:

getGetRecordsRequest in interface DataFetcher

Parameters:

nextIterator - specify the iterator to get the next record request

Returns:

GetRecordsRequest

getNextIterator

public String getNextIterator(software.amazon.awssdk.services.kinesis.model.GetShardIteratorRequest request)
                       throws ExecutionException,
                              InterruptedException,
                              TimeoutException

Description copied from interface: DataFetcher

Gets the next iterator based on the request.

Specified by:

getNextIterator in interface DataFetcher

Parameters:

request - used to obtain the next shard iterator

Returns:

next iterator string

Throws:

ExecutionException

InterruptedException

TimeoutException

getRecords

public software.amazon.awssdk.services.kinesis.model.GetRecordsResponse getRecords(@NonNull
                                                                                   String nextIterator)

Description copied from interface: DataFetcher

Gets the next set of records based on the iterator.

Specified by:

getRecords in interface DataFetcher

Parameters:

nextIterator - specified shard iterator for getting the next set of records

Returns:

GetRecordsResponse