com.amazonaws.services.kinesis.clientlibrary.lib.worker

Class KinesisClientLibConfiguration

java.lang.Object

com.amazonaws.services.kinesis.clientlibrary.lib.worker.KinesisClientLibConfiguration

public class KinesisClientLibConfiguration
extends java.lang.Object

Configuration for the Amazon Kinesis Client Library.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_CLEANUP_LEASES_UPON_SHARDS_COMPLETION Cleanup leases upon shards completion (don't wait until they expire in Kinesis).
static boolean	DEFAULT_DONT_CALL_PROCESS_RECORDS_FOR_EMPTY_RECORD_LIST Don't call processRecords() on the record processor for empty record lists.
static long	DEFAULT_FAILOVER_TIME_MILLIS Fail over time in milliseconds.
static long	DEFAULT_IDLETIME_BETWEEN_READS_MILLIS Idle time between record reads in milliseconds.
static InitialPositionInStream	DEFAULT_INITIAL_POSITION_IN_STREAM The location in the shard from which the KinesisClientLibrary will start fetching records from when the application starts for the first time and there is no checkpoint for the shard.
static int	DEFAULT_MAX_RECORDS Max records to fetch from Kinesis in a single GetRecords call.
static long	DEFAULT_METRICS_BUFFER_TIME_MILLIS Buffer metrics for at most this long before publishing to CloudWatch.
static java.util.Set<java.lang.String>	DEFAULT_METRICS_ENABLED_DIMENSIONS Allowed dimensions for CloudWatch metrics.
static MetricsLevel	DEFAULT_METRICS_LEVEL Metrics level for which to enable CloudWatch metrics.
static int	DEFAULT_METRICS_MAX_QUEUE_SIZE Buffer at most this many metrics before publishing to CloudWatch.
static long	DEFAULT_PARENT_SHARD_POLL_INTERVAL_MILLIS Interval in milliseconds between polling to check for parent shard completion.
static long	DEFAULT_SHARD_SYNC_INTERVAL_MILLIS Shard sync interval in milliseconds - e.g.
static long	DEFAULT_TASK_BACKOFF_TIME_MILLIS Backoff time in milliseconds for Amazon Kinesis Client Library tasks (in the event of failures).
static boolean	DEFAULT_VALIDATE_SEQUENCE_NUMBER_BEFORE_CHECKPOINTING KCL will validate client provided sequence numbers with a call to Amazon Kinesis before checkpointing for calls to RecordProcessorCheckpointer#checkpoint(String) by default.
static java.lang.String	KINESIS_CLIENT_LIB_USER_AGENT User agent set when Amazon Kinesis Client Library makes AWS requests.
static java.util.Set<java.lang.String>	METRICS_ALWAYS_ENABLED_DIMENSIONS Metrics dimensions that always will be enabled regardless of the config provided by user.
static java.util.Set<java.lang.String>	METRICS_DIMENSIONS_ALL Metrics dimensions that signify all possible dimensions.

Constructor Summary

Constructors

Constructor and Description
KinesisClientLibConfiguration(java.lang.String applicationName, java.lang.String streamName, AWSCredentialsProvider kinesisCredentialsProvider, AWSCredentialsProvider dynamoDBCredentialsProvider, AWSCredentialsProvider cloudWatchCredentialsProvider, java.lang.String workerId) Constructor.
KinesisClientLibConfiguration(java.lang.String applicationName, java.lang.String streamName, AWSCredentialsProvider credentialsProvider, java.lang.String workerId) Constructor.
KinesisClientLibConfiguration(java.lang.String applicationName, java.lang.String streamName, java.lang.String kinesisEndpoint, InitialPositionInStream initialPositionInStream, AWSCredentialsProvider kinesisCredentialsProvider, AWSCredentialsProvider dynamoDBCredentialsProvider, AWSCredentialsProvider cloudWatchCredentialsProvider, long failoverTimeMillis, java.lang.String workerId, int maxRecords, long idleTimeBetweenReadsInMillis, boolean callProcessRecordsEvenForEmptyRecordList, long parentShardPollIntervalMillis, long shardSyncIntervalMillis, boolean cleanupTerminatedShardsBeforeExpiry, ClientConfiguration kinesisClientConfig, ClientConfiguration dynamoDBClientConfig, ClientConfiguration cloudWatchClientConfig, long taskBackoffTimeMillis, long metricsBufferTimeMillis, int metricsMaxQueueSize, boolean validateSequenceNumberBeforeCheckpointing, java.lang.String regionName)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getApplicationName()
ClientConfiguration	getCloudWatchClientConfiguration()
AWSCredentialsProvider	getCloudWatchCredentialsProvider()
ClientConfiguration	getDynamoDBClientConfiguration()
AWSCredentialsProvider	getDynamoDBCredentialsProvider()
long	getEpsilonMillis()
long	getFailoverTimeMillis()
long	getIdleTimeBetweenReadsInMillis()
InitialPositionInStream	getInitialPositionInStream()
ClientConfiguration	getKinesisClientConfiguration()
AWSCredentialsProvider	getKinesisCredentialsProvider()
java.lang.String	getKinesisEndpoint()
int	getMaxRecords()
long	getMetricsBufferTimeMillis()
java.util.Set<java.lang.String>	getMetricsEnabledDimensions()
MetricsLevel	getMetricsLevel()
int	getMetricsMaxQueueSize()
long	getParentShardPollIntervalMillis()
java.lang.String	getRegionName()
long	getShardSyncIntervalMillis()
java.lang.String	getStreamName()
long	getTaskBackoffTimeMillis()
java.lang.String	getWorkerIdentifier()
boolean	shouldCallProcessRecordsEvenForEmptyRecordList()
boolean	shouldCleanupLeasesUponShardCompletion()
boolean	shouldValidateSequenceNumberBeforeCheckpointing()
KinesisClientLibConfiguration	withCallProcessRecordsEvenForEmptyRecordList(boolean callProcessRecordsEvenForEmptyRecordList)
KinesisClientLibConfiguration	withCleanupLeasesUponShardCompletion(boolean cleanupLeasesUponShardCompletion)
KinesisClientLibConfiguration	withCloudWatchClientConfig(ClientConfiguration cloudWatchClientConfig)
KinesisClientLibConfiguration	withCommonClientConfig(ClientConfiguration clientConfig)
KinesisClientLibConfiguration	withDynamoDBClientConfig(ClientConfiguration dynamoDBClientConfig)
KinesisClientLibConfiguration	withFailoverTimeMillis(long failoverTimeMillis)
KinesisClientLibConfiguration	withIdleTimeBetweenReadsInMillis(long idleTimeBetweenReadsInMillis)
KinesisClientLibConfiguration	withInitialPositionInStream(InitialPositionInStream initialPositionInStream)
KinesisClientLibConfiguration	withKinesisClientConfig(ClientConfiguration kinesisClientConfig)
KinesisClientLibConfiguration	withKinesisEndpoint(java.lang.String kinesisEndpoint)
KinesisClientLibConfiguration	withMaxRecords(int maxRecords)
KinesisClientLibConfiguration	withMetricsBufferTimeMillis(long metricsBufferTimeMillis)
KinesisClientLibConfiguration	withMetricsEnabledDimensions(java.util.Set<java.lang.String> metricsEnabledDimensions) Sets the dimensions that are allowed to be emitted in metrics.
KinesisClientLibConfiguration	withMetricsLevel(MetricsLevel metricsLevel)
KinesisClientLibConfiguration	withMetricsLevel(java.lang.String metricsLevel) Sets metrics level that should be enabled.
KinesisClientLibConfiguration	withMetricsMaxQueueSize(int metricsMaxQueueSize)
KinesisClientLibConfiguration	withParentShardPollIntervalMillis(long parentShardPollIntervalMillis)
KinesisClientLibConfiguration	withRegionName(java.lang.String regionName)
KinesisClientLibConfiguration	withShardSyncIntervalMillis(long shardSyncIntervalMillis)
KinesisClientLibConfiguration	withTaskBackoffTimeMillis(long taskBackoffTimeMillis)
KinesisClientLibConfiguration	withUserAgent(java.lang.String userAgent) Override the default user agent (application name).
KinesisClientLibConfiguration	withValidateSequenceNumberBeforeCheckpointing(boolean validateSequenceNumberBeforeCheckpointing)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INITIAL_POSITION_IN_STREAM

public static final InitialPositionInStream DEFAULT_INITIAL_POSITION_IN_STREAM

The location in the shard from which the KinesisClientLibrary will start fetching records from when the application starts for the first time and there is no checkpoint for the shard.

DEFAULT_FAILOVER_TIME_MILLIS

public static final long DEFAULT_FAILOVER_TIME_MILLIS

Fail over time in milliseconds. A worker which does not renew it's lease within this time interval will be regarded as having problems and it's shards will be assigned to other workers. For applications that have a large number of shards, this msy be set to a higher number to reduce the number of DynamoDB IOPS required for tracking leases.

See Also:

Constant Field Values

DEFAULT_MAX_RECORDS

public static final int DEFAULT_MAX_RECORDS

Max records to fetch from Kinesis in a single GetRecords call.

See Also:

Constant Field Values

DEFAULT_IDLETIME_BETWEEN_READS_MILLIS

public static final long DEFAULT_IDLETIME_BETWEEN_READS_MILLIS

Idle time between record reads in milliseconds.

See Also:

Constant Field Values

DEFAULT_DONT_CALL_PROCESS_RECORDS_FOR_EMPTY_RECORD_LIST

public static final boolean DEFAULT_DONT_CALL_PROCESS_RECORDS_FOR_EMPTY_RECORD_LIST

Don't call processRecords() on the record processor for empty record lists.

See Also:

Constant Field Values

DEFAULT_PARENT_SHARD_POLL_INTERVAL_MILLIS

public static final long DEFAULT_PARENT_SHARD_POLL_INTERVAL_MILLIS

Interval in milliseconds between polling to check for parent shard completion. Polling frequently will take up more DynamoDB IOPS (when there are leases for shards waiting on completion of parent shards).

See Also:

Constant Field Values

DEFAULT_SHARD_SYNC_INTERVAL_MILLIS

public static final long DEFAULT_SHARD_SYNC_INTERVAL_MILLIS

Shard sync interval in milliseconds - e.g. wait for this long between shard sync tasks.

See Also:

Constant Field Values

DEFAULT_CLEANUP_LEASES_UPON_SHARDS_COMPLETION

public static final boolean DEFAULT_CLEANUP_LEASES_UPON_SHARDS_COMPLETION

Cleanup leases upon shards completion (don't wait until they expire in Kinesis). Keeping leases takes some tracking/resources (e.g. they need to be renewed, assigned), so by default we try to delete the ones we don't need any longer.

See Also:

Constant Field Values

DEFAULT_TASK_BACKOFF_TIME_MILLIS

public static final long DEFAULT_TASK_BACKOFF_TIME_MILLIS

Backoff time in milliseconds for Amazon Kinesis Client Library tasks (in the event of failures).

See Also:

Constant Field Values

DEFAULT_METRICS_BUFFER_TIME_MILLIS

public static final long DEFAULT_METRICS_BUFFER_TIME_MILLIS

Buffer metrics for at most this long before publishing to CloudWatch.

See Also:

Constant Field Values

DEFAULT_METRICS_MAX_QUEUE_SIZE

public static final int DEFAULT_METRICS_MAX_QUEUE_SIZE

Buffer at most this many metrics before publishing to CloudWatch.

See Also:

Constant Field Values

DEFAULT_METRICS_LEVEL

public static final MetricsLevel DEFAULT_METRICS_LEVEL

Metrics level for which to enable CloudWatch metrics.

METRICS_ALWAYS_ENABLED_DIMENSIONS

public static final java.util.Set<java.lang.String> METRICS_ALWAYS_ENABLED_DIMENSIONS

Metrics dimensions that always will be enabled regardless of the config provided by user.

DEFAULT_METRICS_ENABLED_DIMENSIONS

public static final java.util.Set<java.lang.String> DEFAULT_METRICS_ENABLED_DIMENSIONS

Allowed dimensions for CloudWatch metrics. By default, worker ID dimension will be disabled.

METRICS_DIMENSIONS_ALL

public static final java.util.Set<java.lang.String> METRICS_DIMENSIONS_ALL

Metrics dimensions that signify all possible dimensions.

KINESIS_CLIENT_LIB_USER_AGENT

public static final java.lang.String KINESIS_CLIENT_LIB_USER_AGENT

User agent set when Amazon Kinesis Client Library makes AWS requests.

See Also:

Constant Field Values

DEFAULT_VALIDATE_SEQUENCE_NUMBER_BEFORE_CHECKPOINTING

public static final boolean DEFAULT_VALIDATE_SEQUENCE_NUMBER_BEFORE_CHECKPOINTING

KCL will validate client provided sequence numbers with a call to Amazon Kinesis before checkpointing for calls to RecordProcessorCheckpointer#checkpoint(String) by default.

See Also:

Constant Field Values

Constructor Detail

KinesisClientLibConfiguration

public KinesisClientLibConfiguration(java.lang.String applicationName,
                             java.lang.String streamName,
                             AWSCredentialsProvider credentialsProvider,
                             java.lang.String workerId)

Constructor.

Parameters:

applicationName - Name of the Amazon Kinesis application. By default the application name is included in the user agent string used to make AWS requests. This can assist with troubleshooting (e.g. distinguish requests made by separate applications).

streamName - Name of the Kinesis stream

credentialsProvider - Provides credentials used to sign AWS requests

workerId - Used to distinguish different workers/processes of a Kinesis application

KinesisClientLibConfiguration

public KinesisClientLibConfiguration(java.lang.String applicationName,
                             java.lang.String streamName,
                             AWSCredentialsProvider kinesisCredentialsProvider,
                             AWSCredentialsProvider dynamoDBCredentialsProvider,
                             AWSCredentialsProvider cloudWatchCredentialsProvider,
                             java.lang.String workerId)

Constructor.

Parameters:

applicationName - Name of the Amazon Kinesis application By default the application name is included in the user agent string used to make AWS requests. This can assist with troubleshooting (e.g. distinguish requests made by separate applications).

streamName - Name of the Kinesis stream

kinesisCredentialsProvider - Provides credentials used to access Kinesis

dynamoDBCredentialsProvider - Provides credentials used to access DynamoDB

cloudWatchCredentialsProvider - Provides credentials used to access CloudWatch

workerId - Used to distinguish different workers/processes of a Kinesis application

KinesisClientLibConfiguration

public KinesisClientLibConfiguration(java.lang.String applicationName,
                             java.lang.String streamName,
                             java.lang.String kinesisEndpoint,
                             InitialPositionInStream initialPositionInStream,
                             AWSCredentialsProvider kinesisCredentialsProvider,
                             AWSCredentialsProvider dynamoDBCredentialsProvider,
                             AWSCredentialsProvider cloudWatchCredentialsProvider,
                             long failoverTimeMillis,
                             java.lang.String workerId,
                             int maxRecords,
                             long idleTimeBetweenReadsInMillis,
                             boolean callProcessRecordsEvenForEmptyRecordList,
                             long parentShardPollIntervalMillis,
                             long shardSyncIntervalMillis,
                             boolean cleanupTerminatedShardsBeforeExpiry,
                             ClientConfiguration kinesisClientConfig,
                             ClientConfiguration dynamoDBClientConfig,
                             ClientConfiguration cloudWatchClientConfig,
                             long taskBackoffTimeMillis,
                             long metricsBufferTimeMillis,
                             int metricsMaxQueueSize,
                             boolean validateSequenceNumberBeforeCheckpointing,
                             java.lang.String regionName)

Parameters:

applicationName - Name of the Kinesis application By default the application name is included in the user agent string used to make AWS requests. This can assist with troubleshooting (e.g. distinguish requests made by separate applications).

streamName - Name of the Kinesis stream

kinesisEndpoint - Kinesis endpoint

initialPositionInStream - One of LATEST or TRIM_HORIZON. The KinesisClientLibrary will start fetching records from that location in the stream when an application starts up for the first time and there are no checkpoints. If there are checkpoints, then we start from the checkpoint position.

kinesisCredentialsProvider - Provides credentials used to access Kinesis

dynamoDBCredentialsProvider - Provides credentials used to access DynamoDB

cloudWatchCredentialsProvider - Provides credentials used to access CloudWatch

failoverTimeMillis - Lease duration (leases not renewed within this period will be claimed by others)

workerId - Used to distinguish different workers/processes of a Kinesis application

maxRecords - Max records to read per Kinesis getRecords() call

idleTimeBetweenReadsInMillis - Idle time between calls to fetch data from Kinesis

callProcessRecordsEvenForEmptyRecordList - Call the IRecordProcessor::processRecords() API even if GetRecords returned an empty record list.

parentShardPollIntervalMillis - Wait for this long between polls to check if parent shards are done

shardSyncIntervalMillis - Time between tasks to sync leases and Kinesis shards

cleanupTerminatedShardsBeforeExpiry - Clean up shards we've finished processing (don't wait for expiration in Kinesis)

kinesisClientConfig - Client Configuration used by Kinesis client

dynamoDBClientConfig - Client Configuration used by DynamoDB client

cloudWatchClientConfig - Client Configuration used by CloudWatch client

taskBackoffTimeMillis - Backoff period when tasks encounter an exception

metricsBufferTimeMillis - Metrics are buffered for at most this long before publishing to CloudWatch

metricsMaxQueueSize - Max number of metrics to buffer before publishing to CloudWatch

validateSequenceNumberBeforeCheckpointing - whether KCL should validate client provided sequence numbers with a call to Amazon Kinesis before checkpointing for calls to RecordProcessorCheckpointer#checkpoint(String)

regionName - The region name for the service

Method Detail

getApplicationName

public java.lang.String getApplicationName()

Returns:

Name of the application

getFailoverTimeMillis

public long getFailoverTimeMillis()

Returns:

Time within which a worker should renew a lease (else it is assumed dead)

getKinesisCredentialsProvider

public AWSCredentialsProvider getKinesisCredentialsProvider()

Returns:

Credentials provider used to access Kinesis

getDynamoDBCredentialsProvider

public AWSCredentialsProvider getDynamoDBCredentialsProvider()

Returns:

Credentials provider used to access DynamoDB

getCloudWatchCredentialsProvider

public AWSCredentialsProvider getCloudWatchCredentialsProvider()

Returns:

Credentials provider used to access CloudWatch

getWorkerIdentifier

public java.lang.String getWorkerIdentifier()

Returns:

workerIdentifier

getShardSyncIntervalMillis

public long getShardSyncIntervalMillis()

Returns:

the shardSyncIntervalMillis

getMaxRecords

public int getMaxRecords()

Returns:

Max records to fetch per Kinesis getRecords call

getIdleTimeBetweenReadsInMillis

public long getIdleTimeBetweenReadsInMillis()

Returns:

Idle time between calls to fetch data from Kinesis

shouldCallProcessRecordsEvenForEmptyRecordList

public boolean shouldCallProcessRecordsEvenForEmptyRecordList()

Returns:

true if processRecords() should be called even for empty record lists

getEpsilonMillis

public long getEpsilonMillis()

Returns:

Epsilon milliseconds (used for lease timing margins)

getStreamName

public java.lang.String getStreamName()

Returns:

stream name

getKinesisEndpoint

public java.lang.String getKinesisEndpoint()

Returns:

Kinesis endpoint

getInitialPositionInStream

public InitialPositionInStream getInitialPositionInStream()

Returns:

the initialPositionInStream

getParentShardPollIntervalMillis

public long getParentShardPollIntervalMillis()

Returns:

interval between polls for parent shard completion

getKinesisClientConfiguration

public ClientConfiguration getKinesisClientConfiguration()

Returns:

Kinesis client configuration

getDynamoDBClientConfiguration

public ClientConfiguration getDynamoDBClientConfiguration()

Returns:

DynamoDB client configuration

getCloudWatchClientConfiguration

public ClientConfiguration getCloudWatchClientConfiguration()

Returns:

CloudWatch client configuration

getTaskBackoffTimeMillis

public long getTaskBackoffTimeMillis()

Returns:

backoff time when tasks encounter exceptions

getMetricsBufferTimeMillis

public long getMetricsBufferTimeMillis()

Returns:

Metrics are buffered for at most this long before publishing.

getMetricsMaxQueueSize

public int getMetricsMaxQueueSize()

Returns:

Max number of metrics to buffer before publishing.

getMetricsLevel

public MetricsLevel getMetricsLevel()

Returns:

Metrics level enabled for metrics.

getMetricsEnabledDimensions

public java.util.Set<java.lang.String> getMetricsEnabledDimensions()

Returns:

Enabled dimensions for metrics.

shouldCleanupLeasesUponShardCompletion

public boolean shouldCleanupLeasesUponShardCompletion()

Returns:

true if we should clean up leases of shards after processing is complete (don't wait for expiration)

shouldValidateSequenceNumberBeforeCheckpointing

public boolean shouldValidateSequenceNumberBeforeCheckpointing()

Returns:

true if KCL should validate client provided sequence numbers with a call to Amazon Kinesis before checkpointing for calls to RecordProcessorCheckpointer#checkpoint(String)

getRegionName

public java.lang.String getRegionName()

Returns:

Region for the service

withKinesisEndpoint

public KinesisClientLibConfiguration withKinesisEndpoint(java.lang.String kinesisEndpoint)

Parameters:

kinesisEndpoint - Kinesis endpoint

Returns:

KinesisClientLibConfiguration

withInitialPositionInStream

public KinesisClientLibConfiguration withInitialPositionInStream(InitialPositionInStream initialPositionInStream)

Parameters:

initialPositionInStream - One of LATEST or TRIM_HORIZON. The Amazon Kinesis Client Library will start fetching records from this position when the application starts up if there are no checkpoints. If there are checkpoints, we will process records from the checkpoint position.

Returns:

KinesisClientLibConfiguration

withFailoverTimeMillis

public KinesisClientLibConfiguration withFailoverTimeMillis(long failoverTimeMillis)

Parameters:

failoverTimeMillis - Lease duration (leases not renewed within this period will be claimed by others)

Returns:

KinesisClientLibConfiguration

withShardSyncIntervalMillis

public KinesisClientLibConfiguration withShardSyncIntervalMillis(long shardSyncIntervalMillis)

Parameters:

shardSyncIntervalMillis - Time between tasks to sync leases and Kinesis shards

Returns:

KinesisClientLibConfiguration

withMaxRecords

public KinesisClientLibConfiguration withMaxRecords(int maxRecords)

Parameters:

maxRecords - Max records to fetch in a Kinesis getRecords() call

Returns:

KinesisClientLibConfiguration

withIdleTimeBetweenReadsInMillis

public KinesisClientLibConfiguration withIdleTimeBetweenReadsInMillis(long idleTimeBetweenReadsInMillis)

Parameters:

idleTimeBetweenReadsInMillis - Idle time between calls to fetch data from Kinesis

Returns:

KinesisClientLibConfiguration

withCallProcessRecordsEvenForEmptyRecordList

public KinesisClientLibConfiguration withCallProcessRecordsEvenForEmptyRecordList(boolean callProcessRecordsEvenForEmptyRecordList)

Parameters:

callProcessRecordsEvenForEmptyRecordList - Call the RecordProcessor::processRecords() API even if GetRecords returned an empty record list

Returns:

KinesisClientLibConfiguration

withParentShardPollIntervalMillis

public KinesisClientLibConfiguration withParentShardPollIntervalMillis(long parentShardPollIntervalMillis)

Parameters:

parentShardPollIntervalMillis - Wait for this long between polls to check if parent shards are done

Returns:

KinesisClientLibConfiguration

withCleanupLeasesUponShardCompletion

public KinesisClientLibConfiguration withCleanupLeasesUponShardCompletion(boolean cleanupLeasesUponShardCompletion)

Parameters:

cleanupLeasesUponShardCompletion - Clean up shards we've finished processing (don't wait for expiration in Kinesis)

Returns:

KinesisClientLibConfiguration

withCommonClientConfig

public KinesisClientLibConfiguration withCommonClientConfig(ClientConfiguration clientConfig)

Parameters:

clientConfig - Common client configuration used by Kinesis/DynamoDB/CloudWatch client

Returns:

KinesisClientLibConfiguration

withKinesisClientConfig

public KinesisClientLibConfiguration withKinesisClientConfig(ClientConfiguration kinesisClientConfig)

Parameters:

kinesisClientConfig - Client configuration used by Kinesis client

Returns:

KinesisClientLibConfiguration

withDynamoDBClientConfig

public KinesisClientLibConfiguration withDynamoDBClientConfig(ClientConfiguration dynamoDBClientConfig)

Parameters:

dynamoDBClientConfig - Client configuration used by DynamoDB client

Returns:

KinesisClientLibConfiguration

withCloudWatchClientConfig

public KinesisClientLibConfiguration withCloudWatchClientConfig(ClientConfiguration cloudWatchClientConfig)

Parameters:

cloudWatchClientConfig - Client configuration used by CloudWatch client

Returns:

KinesisClientLibConfiguration

withUserAgent

public KinesisClientLibConfiguration withUserAgent(java.lang.String userAgent)

Override the default user agent (application name).

Parameters:

userAgent - User agent to use in AWS requests

Returns:

KinesisClientLibConfiguration

withTaskBackoffTimeMillis

public KinesisClientLibConfiguration withTaskBackoffTimeMillis(long taskBackoffTimeMillis)

Parameters:

taskBackoffTimeMillis - Backoff period when tasks encounter an exception

Returns:

KinesisClientLibConfiguration

withMetricsBufferTimeMillis

public KinesisClientLibConfiguration withMetricsBufferTimeMillis(long metricsBufferTimeMillis)

Parameters:

metricsBufferTimeMillis - Metrics are buffered for at most this long before publishing to CloudWatch

Returns:

KinesisClientLibConfiguration

withMetricsMaxQueueSize

public KinesisClientLibConfiguration withMetricsMaxQueueSize(int metricsMaxQueueSize)

Parameters:

metricsMaxQueueSize - Max number of metrics to buffer before publishing to CloudWatch

Returns:

KinesisClientLibConfiguration

withMetricsLevel

public KinesisClientLibConfiguration withMetricsLevel(MetricsLevel metricsLevel)

Parameters:

metricsLevel - Metrics level to enable.

Returns:

KinesisClientLibConfiguration

withMetricsLevel

public KinesisClientLibConfiguration withMetricsLevel(java.lang.String metricsLevel)

Sets metrics level that should be enabled. Possible values are: NONE SUMMARY DETAILED

Parameters:

metricsLevel - Metrics level to enable.

Returns:

KinesisClientLibConfiguration

withMetricsEnabledDimensions

public KinesisClientLibConfiguration withMetricsEnabledDimensions(java.util.Set<java.lang.String> metricsEnabledDimensions)

Sets the dimensions that are allowed to be emitted in metrics.

Parameters:

metricsEnabledDimensions - Set of dimensions that are allowed.

Returns:

KinesisClientLibConfiguration

withValidateSequenceNumberBeforeCheckpointing

public KinesisClientLibConfiguration withValidateSequenceNumberBeforeCheckpointing(boolean validateSequenceNumberBeforeCheckpointing)

Parameters:

validateSequenceNumberBeforeCheckpointing - whether KCL should validate client provided sequence numbers with a call to Amazon Kinesis before checkpointing for calls to RecordProcessorCheckpointer#checkpoint(String).

Returns:

KinesisClientLibConfiguration

withRegionName

public KinesisClientLibConfiguration withRegionName(java.lang.String regionName)

Parameters:

regionName - The region name for the service

Returns:

KinesisClientLibConfiguration