KinesisClientLibConfiguration (Amazon Kinesis Client Library for Java 1.8.0 API)

java.lang.Object
- com.amazonaws.services.kinesis.clientlibrary.lib.worker.KinesisClientLibConfiguration

public class KinesisClientLibConfiguration
extends 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` The default value for how long the `ShardConsumer` should sleep if no records are returned from the call to `AmazonKinesis.getRecords(com.amazonaws.services.kinesis.model.GetRecordsRequest)`.
`static int`	`DEFAULT_INITIAL_LEASE_TABLE_READ_CAPACITY` The Amazon DynamoDB table used for tracking leases will be provisioned with this read capacity.
`static int`	`DEFAULT_INITIAL_LEASE_TABLE_WRITE_CAPACITY` The Amazon DynamoDB table used for tracking leases will be provisioned with this write capacity.
`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_LEASE_RENEWAL_THREADS` The size of the thread pool to create for the lease renewer to use.
`static int`	`DEFAULT_MAX_LEASES_FOR_WORKER` The max number of leases (shards) this worker should process.
`static int`	`DEFAULT_MAX_LEASES_TO_STEAL_AT_ONE_TIME` Max leases to steal from another worker at one time (for load balancing).
`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 Set<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 ShardPrioritization`	`DEFAULT_SHARD_PRIORITIZATION` Default Shard prioritization strategy.
`static long`	`DEFAULT_SHARD_SYNC_INTERVAL_MILLIS` Shard sync interval in milliseconds - e.g.
`static boolean`	`DEFAULT_SKIP_SHARD_SYNC_AT_STARTUP_IF_LEASES_EXIST` The Worker will skip shard sync during initialization if there are one or more leases in the lease table.
`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 String`	`KINESIS_CLIENT_LIB_USER_AGENT` User agent set when Amazon Kinesis Client Library makes AWS requests.
`static Set<String>`	`METRICS_ALWAYS_ENABLED_DIMENSIONS` Metrics dimensions that always will be enabled regardless of the config provided by user.
`static Set<String>`	`METRICS_DIMENSIONS_ALL` Metrics dimensions that signify all possible dimensions.

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getApplicationName()`
`com.amazonaws.ClientConfiguration`	`getCloudWatchClientConfiguration()`
`com.amazonaws.auth.AWSCredentialsProvider`	`getCloudWatchCredentialsProvider()`
`com.amazonaws.ClientConfiguration`	`getDynamoDBClientConfiguration()`
`com.amazonaws.auth.AWSCredentialsProvider`	`getDynamoDBCredentialsProvider()`
`String`	`getDynamoDBEndpoint()`
`long`	`getEpsilonMillis()`
`long`	`getFailoverTimeMillis()`
`long`	`getIdleTimeBetweenReadsInMillis()`
`int`	`getInitialLeaseTableReadCapacity()`
`int`	`getInitialLeaseTableWriteCapacity()`
`InitialPositionInStream`	`getInitialPositionInStream()`
`protected com.amazonaws.services.kinesis.clientlibrary.lib.worker.InitialPositionInStreamExtended`	`getInitialPositionInStreamExtended()` Keeping it protected to forbid outside callers from depending on this internal object.
`com.amazonaws.ClientConfiguration`	`getKinesisClientConfiguration()`
`com.amazonaws.auth.AWSCredentialsProvider`	`getKinesisCredentialsProvider()`
`String`	`getKinesisEndpoint()`
`int`	`getMaxLeasesForWorker()`
`int`	`getMaxLeasesToStealAtOneTime()`
`int`	`getMaxRecords()`
`long`	`getMetricsBufferTimeMillis()`
`Set<String>`	`getMetricsEnabledDimensions()`
`MetricsLevel`	`getMetricsLevel()`
`int`	`getMetricsMaxQueueSize()`
`long`	`getParentShardPollIntervalMillis()`
`String`	`getRegionName()`
`ShardPrioritization`	`getShardPrioritizationStrategy()`
`long`	`getShardSyncIntervalMillis()`
`boolean`	`getSkipShardSyncAtWorkerInitializationIfLeasesExist()`
`String`	`getStreamName()`
`String`	`getTableName()`
`long`	`getTaskBackoffTimeMillis()`
`Date`	`getTimestampAtInitialPositionInStream()`
`String`	`getWorkerIdentifier()`
`boolean`	`shouldCallProcessRecordsEvenForEmptyRecordList()`
`boolean`	`shouldCleanupLeasesUponShardCompletion()`
`boolean`	`shouldValidateSequenceNumberBeforeCheckpointing()`
`KinesisClientLibConfiguration`	`withCallProcessRecordsEvenForEmptyRecordList(boolean callProcessRecordsEvenForEmptyRecordList)`
`KinesisClientLibConfiguration`	`withCleanupLeasesUponShardCompletion(boolean cleanupLeasesUponShardCompletion)`
`KinesisClientLibConfiguration`	`withCloudWatchClientConfig(com.amazonaws.ClientConfiguration cloudWatchClientConfig)`
`KinesisClientLibConfiguration`	`withCommonClientConfig(com.amazonaws.ClientConfiguration clientConfig)`
`KinesisClientLibConfiguration`	`withDynamoDBClientConfig(com.amazonaws.ClientConfiguration dynamoDBClientConfig)`
`KinesisClientLibConfiguration`	`withDynamoDBEndpoint(String dynamoDBEndpoint)`
`KinesisClientLibConfiguration`	`withFailoverTimeMillis(long failoverTimeMillis)`
`KinesisClientLibConfiguration`	`withIdleTimeBetweenReadsInMillis(long idleTimeBetweenReadsInMillis)` Controls how long the KCL will sleep if no records are returned from Kinesis
`KinesisClientLibConfiguration`	`withInitialLeaseTableReadCapacity(int initialLeaseTableReadCapacity)`
`KinesisClientLibConfiguration`	`withInitialLeaseTableWriteCapacity(int initialLeaseTableWriteCapacity)`
`KinesisClientLibConfiguration`	`withInitialPositionInStream(InitialPositionInStream initialPositionInStream)`
`KinesisClientLibConfiguration`	`withKinesisClientConfig(com.amazonaws.ClientConfiguration kinesisClientConfig)`
`KinesisClientLibConfiguration`	`withKinesisEndpoint(String kinesisEndpoint)`
`KinesisClientLibConfiguration`	`withMaxLeaseRenewalThreads(int maxLeaseRenewalThreads)` Sets the size of the thread pool that will be used to renew leases.
`KinesisClientLibConfiguration`	`withMaxLeasesForWorker(int maxLeasesForWorker)` Worker will not acquire more than the specified max number of leases even if there are more shards that need to be processed.
`KinesisClientLibConfiguration`	`withMaxLeasesToStealAtOneTime(int maxLeasesToStealAtOneTime)` Max leases to steal from a more loaded Worker at one time (for load balancing).
`KinesisClientLibConfiguration`	`withMaxRecords(int maxRecords)`
`KinesisClientLibConfiguration`	`withMetricsBufferTimeMillis(long metricsBufferTimeMillis)`
`KinesisClientLibConfiguration`	`withMetricsEnabledDimensions(Set<String> metricsEnabledDimensions)` Sets the dimensions that are allowed to be emitted in metrics.
`KinesisClientLibConfiguration`	`withMetricsLevel(MetricsLevel metricsLevel)`
`KinesisClientLibConfiguration`	`withMetricsLevel(String metricsLevel)` Sets metrics level that should be enabled.
`KinesisClientLibConfiguration`	`withMetricsMaxQueueSize(int metricsMaxQueueSize)`
`KinesisClientLibConfiguration`	`withParentShardPollIntervalMillis(long parentShardPollIntervalMillis)`
`KinesisClientLibConfiguration`	`withRegionName(String regionName)`
`KinesisClientLibConfiguration`	`withShardPrioritizationStrategy(ShardPrioritization shardPrioritization)`
`KinesisClientLibConfiguration`	`withShardSyncIntervalMillis(long shardSyncIntervalMillis)`
`KinesisClientLibConfiguration`	`withSkipShardSyncAtStartupIfLeasesExist(boolean skipShardSyncAtStartupIfLeasesExist)` If set to true, the Worker will not sync shards and leases during initialization if there are one or more leases in the lease table.
`KinesisClientLibConfiguration`	`withTableName(String tableName)`
`KinesisClientLibConfiguration`	`withTaskBackoffTimeMillis(long taskBackoffTimeMillis)`
`KinesisClientLibConfiguration`	`withTimestampAtInitialPositionInStream(Date timestamp)`
`KinesisClientLibConfiguration`	`withUserAgent(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 may 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
```
    The default value for how long the ShardConsumer should sleep if no records are returned from the call to AmazonKinesis.getRecords(com.amazonaws.services.kinesis.model.GetRecordsRequest).
    
    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 Set<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 Set<String> DEFAULT_METRICS_ENABLED_DIMENSIONS
```
    Allowed dimensions for CloudWatch metrics. By default, worker ID dimension will be disabled.
  - METRICS_DIMENSIONS_ALL
```
public static final Set<String> METRICS_DIMENSIONS_ALL
```
    Metrics dimensions that signify all possible dimensions.
  - KINESIS_CLIENT_LIB_USER_AGENT
```
public static final 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
  - DEFAULT_MAX_LEASES_FOR_WORKER
```
public static final int DEFAULT_MAX_LEASES_FOR_WORKER
```
    The max number of leases (shards) this worker should process. This can be useful to avoid overloading (and thrashing) a worker when a host has resource constraints or during deployment. NOTE: Setting this to a low value can cause data loss if workers are not able to pick up all shards in the stream due to the max limit.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_LEASES_TO_STEAL_AT_ONE_TIME
```
public static final int DEFAULT_MAX_LEASES_TO_STEAL_AT_ONE_TIME
```
    Max leases to steal from another worker at one time (for load balancing). Setting this to a higher number can allow for faster load convergence (e.g. during deployments, cold starts), but can cause higher churn in the system.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INITIAL_LEASE_TABLE_READ_CAPACITY
```
public static final int DEFAULT_INITIAL_LEASE_TABLE_READ_CAPACITY
```
    The Amazon DynamoDB table used for tracking leases will be provisioned with this read capacity.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INITIAL_LEASE_TABLE_WRITE_CAPACITY
```
public static final int DEFAULT_INITIAL_LEASE_TABLE_WRITE_CAPACITY
```
    The Amazon DynamoDB table used for tracking leases will be provisioned with this write capacity.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SKIP_SHARD_SYNC_AT_STARTUP_IF_LEASES_EXIST
```
public static final boolean DEFAULT_SKIP_SHARD_SYNC_AT_STARTUP_IF_LEASES_EXIST
```
    The Worker will skip shard sync during initialization if there are one or more leases in the lease table. This assumes that the shards and leases are in-sync. This enables customers to choose faster startup times (e.g. during incremental deployments of an application).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SHARD_PRIORITIZATION
```
public static final ShardPrioritization DEFAULT_SHARD_PRIORITIZATION
```
    Default Shard prioritization strategy.
  - DEFAULT_MAX_LEASE_RENEWAL_THREADS
```
public static final int DEFAULT_MAX_LEASE_RENEWAL_THREADS
```
    The size of the thread pool to create for the lease renewer to use.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - KinesisClientLibConfiguration
```
public KinesisClientLibConfiguration(String applicationName,
                                     String streamName,
                                     com.amazonaws.auth.AWSCredentialsProvider credentialsProvider,
                                     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(String applicationName,
                                     String streamName,
                                     com.amazonaws.auth.AWSCredentialsProvider kinesisCredentialsProvider,
                                     com.amazonaws.auth.AWSCredentialsProvider dynamoDBCredentialsProvider,
                                     com.amazonaws.auth.AWSCredentialsProvider cloudWatchCredentialsProvider,
                                     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(String applicationName,
                                     String streamName,
                                     String kinesisEndpoint,
                                     InitialPositionInStream initialPositionInStream,
                                     com.amazonaws.auth.AWSCredentialsProvider kinesisCredentialsProvider,
                                     com.amazonaws.auth.AWSCredentialsProvider dynamoDBCredentialsProvider,
                                     com.amazonaws.auth.AWSCredentialsProvider cloudWatchCredentialsProvider,
                                     long failoverTimeMillis,
                                     String workerId,
                                     int maxRecords,
                                     long idleTimeBetweenReadsInMillis,
                                     boolean callProcessRecordsEvenForEmptyRecordList,
                                     long parentShardPollIntervalMillis,
                                     long shardSyncIntervalMillis,
                                     boolean cleanupTerminatedShardsBeforeExpiry,
                                     com.amazonaws.ClientConfiguration kinesisClientConfig,
                                     com.amazonaws.ClientConfiguration dynamoDBClientConfig,
                                     com.amazonaws.ClientConfiguration cloudWatchClientConfig,
                                     long taskBackoffTimeMillis,
                                     long metricsBufferTimeMillis,
                                     int metricsMaxQueueSize,
                                     boolean validateSequenceNumberBeforeCheckpointing,
                                     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
  - KinesisClientLibConfiguration
```
public KinesisClientLibConfiguration(String applicationName,
                                     String streamName,
                                     String kinesisEndpoint,
                                     String dynamoDBEndpoint,
                                     InitialPositionInStream initialPositionInStream,
                                     com.amazonaws.auth.AWSCredentialsProvider kinesisCredentialsProvider,
                                     com.amazonaws.auth.AWSCredentialsProvider dynamoDBCredentialsProvider,
                                     com.amazonaws.auth.AWSCredentialsProvider cloudWatchCredentialsProvider,
                                     long failoverTimeMillis,
                                     String workerId,
                                     int maxRecords,
                                     long idleTimeBetweenReadsInMillis,
                                     boolean callProcessRecordsEvenForEmptyRecordList,
                                     long parentShardPollIntervalMillis,
                                     long shardSyncIntervalMillis,
                                     boolean cleanupTerminatedShardsBeforeExpiry,
                                     com.amazonaws.ClientConfiguration kinesisClientConfig,
                                     com.amazonaws.ClientConfiguration dynamoDBClientConfig,
                                     com.amazonaws.ClientConfiguration cloudWatchClientConfig,
                                     long taskBackoffTimeMillis,
                                     long metricsBufferTimeMillis,
                                     int metricsMaxQueueSize,
                                     boolean validateSequenceNumberBeforeCheckpointing,
                                     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
    
    dynamoDBEndpoint - DynamoDB 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 String getApplicationName()
```
    Returns:
    
    Name of the application
  - getTableName
```
public String getTableName()
```
    Returns:
    
    Name of the table to use in DynamoDB
  - getFailoverTimeMillis
```
public long getFailoverTimeMillis()
```
    Returns:
    
    Time within which a worker should renew a lease (else it is assumed dead)
  - getKinesisCredentialsProvider
```
public com.amazonaws.auth.AWSCredentialsProvider getKinesisCredentialsProvider()
```
    Returns:
    
    Credentials provider used to access Kinesis
  - getDynamoDBCredentialsProvider
```
public com.amazonaws.auth.AWSCredentialsProvider getDynamoDBCredentialsProvider()
```
    Returns:
    
    Credentials provider used to access DynamoDB
  - getCloudWatchCredentialsProvider
```
public com.amazonaws.auth.AWSCredentialsProvider getCloudWatchCredentialsProvider()
```
    Returns:
    
    Credentials provider used to access CloudWatch
  - getWorkerIdentifier
```
public 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 String getStreamName()
```
    Returns:
    
    stream name
  - getKinesisEndpoint
```
public String getKinesisEndpoint()
```
    Returns:
    
    Kinesis endpoint
  - getDynamoDBEndpoint
```
public String getDynamoDBEndpoint()
```
    Returns:
    
    DynamoDB endpoint
  - getInitialPositionInStream
```
public InitialPositionInStream getInitialPositionInStream()
```
    Returns:
    
    the initialPositionInStream
  - getParentShardPollIntervalMillis
```
public long getParentShardPollIntervalMillis()
```
    Returns:
    
    interval between polls for parent shard completion
  - getKinesisClientConfiguration
```
public com.amazonaws.ClientConfiguration getKinesisClientConfiguration()
```
    Returns:
    
    Kinesis client configuration
  - getDynamoDBClientConfiguration
```
public com.amazonaws.ClientConfiguration getDynamoDBClientConfiguration()
```
    Returns:
    
    DynamoDB client configuration
  - getCloudWatchClientConfiguration
```
public com.amazonaws.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 Set<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 String getRegionName()
```
    Returns:
    
    Region for the service
  - getSkipShardSyncAtWorkerInitializationIfLeasesExist
```
public boolean getSkipShardSyncAtWorkerInitializationIfLeasesExist()
```
    Returns:
    
    true if Worker should skip syncing shards and leases at startup if leases are present
  - getMaxLeasesForWorker
```
public int getMaxLeasesForWorker()
```
    Returns:
    
    Max leases this Worker can handle at a time
  - getMaxLeasesToStealAtOneTime
```
public int getMaxLeasesToStealAtOneTime()
```
    Returns:
    
    Max leases to steal at one time (for load balancing)
  - getInitialLeaseTableReadCapacity
```
public int getInitialLeaseTableReadCapacity()
```
    Returns:
    
    Read capacity to provision when creating the lease table.
  - getInitialLeaseTableWriteCapacity
```
public int getInitialLeaseTableWriteCapacity()
```
    Returns:
    
    Write capacity to provision when creating the lease table.
  - getInitialPositionInStreamExtended
```
protected com.amazonaws.services.kinesis.clientlibrary.lib.worker.InitialPositionInStreamExtended getInitialPositionInStreamExtended()
```
    Keeping it protected to forbid outside callers from depending on this internal object.
    
    Returns:
    
    The initialPositionInStreamExtended object.
  - getTimestampAtInitialPositionInStream
```
public Date getTimestampAtInitialPositionInStream()
```
    Returns:
    
    The timestamp from where we need to start the application. Valid only for initial position of type AT_TIMESTAMP, returns null for other positions.
  - getShardPrioritizationStrategy
```
public ShardPrioritization getShardPrioritizationStrategy()
```
    Returns:
    
    Shard prioritization strategy.
  - withTableName
```
public KinesisClientLibConfiguration withTableName(String tableName)
```
    Parameters:
    
    tableName - name of the lease table in DynamoDB
    
    Returns:
    
    KinesisClientLibConfiguration
  - withKinesisEndpoint
```
public KinesisClientLibConfiguration withKinesisEndpoint(String kinesisEndpoint)
```
    Parameters:
    
    kinesisEndpoint - Kinesis endpoint
    
    Returns:
    
    KinesisClientLibConfiguration
  - withDynamoDBEndpoint
```
public KinesisClientLibConfiguration withDynamoDBEndpoint(String dynamoDBEndpoint)
```
    Parameters:
    
    dynamoDBEndpoint - DynamoDB 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
  - withTimestampAtInitialPositionInStream
```
public KinesisClientLibConfiguration withTimestampAtInitialPositionInStream(Date timestamp)
```
    Parameters:
    
    timestamp - The timestamp to use with the AT_TIMESTAMP value for initialPositionInStream.
    
    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)
```
    Controls how long the KCL will sleep if no records are returned from Kinesis
    This value is only used when no records are returned; if records are returned, the ProcessTask will immediately retrieve the next set of records after the call to IRecordProcessor.processRecords(ProcessRecordsInput) has returned. Setting this value to high may result in the KCL being unable to catch up. If you are changing this value it's recommended that you enable withCallProcessRecordsEvenForEmptyRecordList(boolean), and monitor how far behind the records retrieved are by inspecting ProcessRecordsInput.getMillisBehindLatest(), and the CloudWatch Metric: GetRecords.MillisBehindLatest
    
    Parameters:
    
    idleTimeBetweenReadsInMillis - how long to sleep between GetRecords calls when no records are returned.
    
    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(com.amazonaws.ClientConfiguration clientConfig)
```
    Parameters:
    
    clientConfig - Common client configuration used by Kinesis/DynamoDB/CloudWatch client
    
    Returns:
    
    KinesisClientLibConfiguration
  - withKinesisClientConfig
```
public KinesisClientLibConfiguration withKinesisClientConfig(com.amazonaws.ClientConfiguration kinesisClientConfig)
```
    Parameters:
    
    kinesisClientConfig - Client configuration used by Kinesis client
    
    Returns:
    
    KinesisClientLibConfiguration
  - withDynamoDBClientConfig
```
public KinesisClientLibConfiguration withDynamoDBClientConfig(com.amazonaws.ClientConfiguration dynamoDBClientConfig)
```
    Parameters:
    
    dynamoDBClientConfig - Client configuration used by DynamoDB client
    
    Returns:
    
    KinesisClientLibConfiguration
  - withCloudWatchClientConfig
```
public KinesisClientLibConfiguration withCloudWatchClientConfig(com.amazonaws.ClientConfiguration cloudWatchClientConfig)
```
    Parameters:
    
    cloudWatchClientConfig - Client configuration used by CloudWatch client
    
    Returns:
    
    KinesisClientLibConfiguration
  - withUserAgent
```
public KinesisClientLibConfiguration withUserAgent(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(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(Set<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
  - withSkipShardSyncAtStartupIfLeasesExist
```
public KinesisClientLibConfiguration withSkipShardSyncAtStartupIfLeasesExist(boolean skipShardSyncAtStartupIfLeasesExist)
```
    If set to true, the Worker will not sync shards and leases during initialization if there are one or more leases in the lease table. This assumes that the shards and leases are in-sync. This enables customers to choose faster startup times (e.g. during incremental deployments of an application).
    
    Parameters:
    
    skipShardSyncAtStartupIfLeasesExist - Should Worker skip syncing shards and leases at startup (Worker initialization).
    
    Returns:
    
    KinesisClientLibConfiguration
  - withRegionName
```
public KinesisClientLibConfiguration withRegionName(String regionName)
```
    Parameters:
    
    regionName - The region name for the service
    
    Returns:
    
    KinesisClientLibConfiguration
  - withMaxLeasesForWorker
```
public KinesisClientLibConfiguration withMaxLeasesForWorker(int maxLeasesForWorker)
```
    Worker will not acquire more than the specified max number of leases even if there are more shards that need to be processed. This can be used in scenarios where a worker is resource constrained or to prevent lease thrashing when small number of workers pick up all leases for small amount of time during deployment. Note that setting a low value may cause data loss (e.g. if there aren't enough Workers to make progress on all shards). When setting the value for this property, one must ensure enough workers are present to process shards and should consider future resharding, child shards that may be blocked on parent shards, some workers becoming unhealthy, etc.
    
    Parameters:
    
    maxLeasesForWorker - Max leases this Worker can handle at a time
    
    Returns:
    
    KinesisClientLibConfiguration
  - withMaxLeasesToStealAtOneTime
```
public KinesisClientLibConfiguration withMaxLeasesToStealAtOneTime(int maxLeasesToStealAtOneTime)
```
    Max leases to steal from a more loaded Worker at one time (for load balancing). Setting this to a higher number can allow for faster load convergence (e.g. during deployments, cold starts), but can cause higher churn in the system.
    
    Parameters:
    
    maxLeasesToStealAtOneTime - Steal up to this many leases at one time (for load balancing)
    
    Returns:
    
    KinesisClientLibConfiguration
  - withInitialLeaseTableReadCapacity
```
public KinesisClientLibConfiguration withInitialLeaseTableReadCapacity(int initialLeaseTableReadCapacity)
```
    Parameters:
    
    initialLeaseTableReadCapacity - Read capacity to provision when creating the lease table.
    
    Returns:
    
    KinesisClientLibConfiguration
  - withInitialLeaseTableWriteCapacity
```
public KinesisClientLibConfiguration withInitialLeaseTableWriteCapacity(int initialLeaseTableWriteCapacity)
```
    Parameters:
    
    initialLeaseTableWriteCapacity - Write capacity to provision when creating the lease table.
    
    Returns:
    
    KinesisClientLibConfiguration
  - withShardPrioritizationStrategy
```
public KinesisClientLibConfiguration withShardPrioritizationStrategy(ShardPrioritization shardPrioritization)
```
    Parameters:
    
    shardPrioritization - Implementation of ShardPrioritization interface that should be used during processing.
    
    Returns:
    
    KinesisClientLibConfiguration
  - withMaxLeaseRenewalThreads
```
public KinesisClientLibConfiguration withMaxLeaseRenewalThreads(int maxLeaseRenewalThreads)
```
    Sets the size of the thread pool that will be used to renew leases. Setting this to low may starve the lease renewal process, and cause the worker to lose leases at a higher rate.
    
    Parameters:
    
    maxLeaseRenewalThreads - the maximum size of the lease renewal thread pool
    
    Returns:
    
    this configuration object
    
    Throws:
    
    IllegalArgumentException - if maxLeaseRenewalThreads is <= 0

Class KinesisClientLibConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_INITIAL_POSITION_IN_STREAM

DEFAULT_FAILOVER_TIME_MILLIS

DEFAULT_MAX_RECORDS

DEFAULT_IDLETIME_BETWEEN_READS_MILLIS

DEFAULT_DONT_CALL_PROCESS_RECORDS_FOR_EMPTY_RECORD_LIST

DEFAULT_PARENT_SHARD_POLL_INTERVAL_MILLIS

DEFAULT_SHARD_SYNC_INTERVAL_MILLIS

DEFAULT_CLEANUP_LEASES_UPON_SHARDS_COMPLETION

DEFAULT_TASK_BACKOFF_TIME_MILLIS

DEFAULT_METRICS_BUFFER_TIME_MILLIS

DEFAULT_METRICS_MAX_QUEUE_SIZE

DEFAULT_METRICS_LEVEL

METRICS_ALWAYS_ENABLED_DIMENSIONS

DEFAULT_METRICS_ENABLED_DIMENSIONS

METRICS_DIMENSIONS_ALL

KINESIS_CLIENT_LIB_USER_AGENT

DEFAULT_VALIDATE_SEQUENCE_NUMBER_BEFORE_CHECKPOINTING

DEFAULT_MAX_LEASES_FOR_WORKER

DEFAULT_MAX_LEASES_TO_STEAL_AT_ONE_TIME

DEFAULT_INITIAL_LEASE_TABLE_READ_CAPACITY

DEFAULT_INITIAL_LEASE_TABLE_WRITE_CAPACITY

DEFAULT_SKIP_SHARD_SYNC_AT_STARTUP_IF_LEASES_EXIST

DEFAULT_SHARD_PRIORITIZATION

DEFAULT_MAX_LEASE_RENEWAL_THREADS

Constructor Detail

KinesisClientLibConfiguration

KinesisClientLibConfiguration

KinesisClientLibConfiguration

KinesisClientLibConfiguration

Method Detail

getApplicationName

getTableName

getFailoverTimeMillis

getKinesisCredentialsProvider

getDynamoDBCredentialsProvider

getCloudWatchCredentialsProvider

getWorkerIdentifier

getShardSyncIntervalMillis

getMaxRecords

getIdleTimeBetweenReadsInMillis

shouldCallProcessRecordsEvenForEmptyRecordList

getEpsilonMillis

getStreamName

getKinesisEndpoint

getDynamoDBEndpoint

getInitialPositionInStream

getParentShardPollIntervalMillis

getKinesisClientConfiguration

getDynamoDBClientConfiguration

getCloudWatchClientConfiguration

getTaskBackoffTimeMillis

getMetricsBufferTimeMillis

getMetricsMaxQueueSize

getMetricsLevel

getMetricsEnabledDimensions

shouldCleanupLeasesUponShardCompletion

shouldValidateSequenceNumberBeforeCheckpointing

getRegionName

getSkipShardSyncAtWorkerInitializationIfLeasesExist

getMaxLeasesForWorker

getMaxLeasesToStealAtOneTime

getInitialLeaseTableReadCapacity

getInitialLeaseTableWriteCapacity

getInitialPositionInStreamExtended

getTimestampAtInitialPositionInStream

getShardPrioritizationStrategy

withTableName

withKinesisEndpoint

withDynamoDBEndpoint

withInitialPositionInStream

withTimestampAtInitialPositionInStream

withFailoverTimeMillis

withShardSyncIntervalMillis

withMaxRecords