software.amazon.kinesis.retrieval.polling

Interface DataFetcher

All Known Implementing Classes:

KinesisDataFetcher

public interface DataFetcher

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) Gets the next set of records based on the 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(@NonNull String nextIterator) Gets the next set of records based on the iterator.
StreamIdentifier	getStreamIdentifier() Get the current account and stream information.
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.
boolean	isShardEndReached() Checks if shardEnd is reached.
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.

Method Detail

getRecords

DataFetcherResult getRecords()

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

Returns:

list of records of up to maxRecords size

initialize

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

void initialize(ExtendedSequenceNumber initialCheckpoint,
                InitialPositionInStreamExtended initialPositionInStream)

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

Parameters:

initialCheckpoint - Current checkpoint sequence number for this shard.

initialPositionInStream - The initialPositionInStream.

advanceIteratorTo

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

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

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

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

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.

getStreamIdentifier

StreamIdentifier getStreamIdentifier()

Get the current account and stream information.

Returns:

StreamIdentifier

isShardEndReached

boolean isShardEndReached()

Checks if shardEnd is reached.

Returns:

boolean to determine whether shard end is reached

getGetRecordsResponse

software.amazon.awssdk.services.kinesis.model.GetRecordsResponse getGetRecordsResponse(software.amazon.awssdk.services.kinesis.model.GetRecordsRequest request)
                                                                                throws Exception

Retrieves the response based on the request.

Parameters:

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

Returns:

GetRecordsResponse response for getRecords

Throws:

Exception

getGetRecordsRequest

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

Gets the next set of records based on the iterator.

Parameters:

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

Returns:

GetRecordsResponseAdapter

getNextIterator

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

Gets the next iterator based on the request.

Parameters:

request - used to obtain the next shard iterator

Returns:

next iterator string

Throws:

ExecutionException

InterruptedException

TimeoutException

getRecords

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

Gets the next set of records based on the iterator.

Parameters:

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

Returns:

GetRecordsResponse