software.amazon.kinesis.retrieval

Interface GetRecordsRetrievalStrategy

All Known Implementing Classes:

AsynchronousGetRecordsRetrievalStrategy, SynchronousGetRecordsRetrievalStrategy

public interface GetRecordsRetrievalStrategy

Represents a strategy to retrieve records from Kinesis. Allows for variations on how records are retrieved from Kinesis.

Method Summary

Modifier and Type	Method and Description
default DataFetcher	dataFetcher() Returns a dataFetcher by first checking for an override if it exists, else using the default data fetcher.
KinesisDataFetcher	getDataFetcher() Returns a DataFetcher used to records from Kinesis.
default Optional<DataFetcher>	getDataFetcherOverride() Returns a DataFetcher override if applicable, else empty for retrieving records from Kinesis.
software.amazon.awssdk.services.kinesis.model.GetRecordsResponse	getRecords(int maxRecords) Gets a set of records from Kinesis.
boolean	isShutdown() Returns whether this strategy has been shutdown.
void	shutdown() Releases any resources used by the strategy.

Method Detail

getRecords

software.amazon.awssdk.services.kinesis.model.GetRecordsResponse getRecords(int maxRecords)

Gets a set of records from Kinesis.

Parameters:

maxRecords - passed to Kinesis, and can be used to restrict the number of records returned from Kinesis.

Returns:

the resulting records.

Throws:

IllegalStateException - if the strategy has been shutdown.

shutdown

void shutdown()

Releases any resources used by the strategy. Once the strategy is shutdown it is no longer safe to call getRecords(int).

isShutdown

boolean isShutdown()

Returns whether this strategy has been shutdown.

Returns:

true if the strategy has been shutdown, false otherwise.

getDataFetcher

KinesisDataFetcher getDataFetcher()

Returns a DataFetcher used to records from Kinesis.

Returns:

DataFetcher

getDataFetcherOverride

default Optional<DataFetcher> getDataFetcherOverride()

Returns a DataFetcher override if applicable, else empty for retrieving records from Kinesis.

Returns:

Optional

dataFetcher

default DataFetcher dataFetcher()

Returns a dataFetcher by first checking for an override if it exists, else using the default data fetcher.

Returns:

DataFetcher