software.amazon.kinesis.retrieval.polling

Class PollingConfig

java.lang.Object

software.amazon.kinesis.retrieval.polling.PollingConfig

All Implemented Interfaces:

RetrievalSpecificConfig

public class PollingConfig
extends Object
implements RetrievalSpecificConfig

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_RECORDS
static long	DEFAULT_MILLIS_BEHIND_LATEST_THRESHOLD_FOR_REDUCED_TPS Default value for millisBehindLatestThresholdForReducedTps.
static Duration	DEFAULT_REQUEST_TIMEOUT
static long	MIN_IDLE_MILLIS_BETWEEN_READS

Constructor Summary

Constructors

Constructor and Description
PollingConfig(software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient)
PollingConfig(String streamName, software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient)

Method Summary

Modifier and Type	Method and Description
PollingConfig	idleTimeBetweenReadsInMillis(long idleTimeBetweenReadsInMillis) Set the value for how long the ShardConsumer should sleep in between calls to KinesisAsyncClient.getRecords(GetRecordsRequest).
PollingConfig	maxRecords(int maxRecords)
RetrievalFactory	retrievalFactory() Creates and returns a retrieval factory for the specific configuration
void	setIdleTimeBetweenReadsInMillis(long idleTimeBetweenReadsInMillis) Deprecated.
void	validateState(boolean isMultiStream) Validates this instance is configured properly.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_REQUEST_TIMEOUT

public static final Duration DEFAULT_REQUEST_TIMEOUT

DEFAULT_MAX_RECORDS

public static final int DEFAULT_MAX_RECORDS

See Also:

Constant Field Values

MIN_IDLE_MILLIS_BETWEEN_READS

public static final long MIN_IDLE_MILLIS_BETWEEN_READS

See Also:

Constant Field Values

DEFAULT_MILLIS_BEHIND_LATEST_THRESHOLD_FOR_REDUCED_TPS

public static long DEFAULT_MILLIS_BEHIND_LATEST_THRESHOLD_FOR_REDUCED_TPS

Default value for millisBehindLatestThresholdForReducedTps. A value of 0 effectively disables the reduced TPS functionality.

Constructor Detail

PollingConfig

public PollingConfig(software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient)

Parameters:

kinesisClient - Client used to access Kinesis services.

PollingConfig

public PollingConfig(String streamName,
                     software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient)

Parameters:

streamName - Name of Kinesis stream.

kinesisClient - Client used to access Kinesis serivces.

Method Detail

setIdleTimeBetweenReadsInMillis

@Deprecated
public void setIdleTimeBetweenReadsInMillis(long idleTimeBetweenReadsInMillis)

Deprecated.

idleTimeBetweenReadsInMillis

public PollingConfig idleTimeBetweenReadsInMillis(long idleTimeBetweenReadsInMillis)

Set the value for how long the ShardConsumer should sleep in between calls to KinesisAsyncClient.getRecords(GetRecordsRequest). If this is not specified here the value provided in RecordsFetcherFactory will be used. Cannot set value below MIN_IDLE_MILLIS_BETWEEN_READS.

maxRecords

public PollingConfig maxRecords(int maxRecords)

retrievalFactory

public RetrievalFactory retrievalFactory()

Description copied from interface: RetrievalSpecificConfig

Creates and returns a retrieval factory for the specific configuration

Specified by:

retrievalFactory in interface RetrievalSpecificConfig

Returns:

a retrieval factory that can create an appropriate retriever

validateState

public void validateState(boolean isMultiStream)

Description copied from interface: RetrievalSpecificConfig

Validates this instance is configured properly. For example, this method may validate that the stream name, if one is required, is non-null.

If not in a valid state, an informative unchecked Exception -- for example, an IllegalArgumentException -- should be thrown so the caller may rectify the misconfiguration.

Specified by:

validateState in interface RetrievalSpecificConfig

Parameters:

isMultiStream - whether state should be validated for multi-stream