software.amazon.kinesis.common

Class ConfigsBuilder

java.lang.Object

software.amazon.kinesis.common.ConfigsBuilder

public class ConfigsBuilder
extends Object

This Builder is useful to create all configurations for the KCL with default values.

Constructor Summary

Constructors

Constructor and Description
ConfigsBuilder(MultiStreamTracker multiStreamTracker, String applicationName, software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient, software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient dynamoDBClient, software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient cloudWatchClient, String workerIdentifier, ShardRecordProcessorFactory shardRecordProcessorFactory) Constructor to initialize ConfigsBuilder with MultiStreamTracker
ConfigsBuilder(String streamName, String applicationName, software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient, software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient dynamoDBClient, software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient cloudWatchClient, String workerIdentifier, ShardRecordProcessorFactory shardRecordProcessorFactory) Constructor to initialize ConfigsBuilder with StreamName

Method Summary

Modifier and Type	Method and Description
CheckpointConfig	checkpointConfig() Creates a new instance of CheckpointConfig
CoordinatorConfig	coordinatorConfig() Creates a new instance of CoordinatorConfig
LeaseManagementConfig	leaseManagementConfig() Creates a new instance of LeaseManagementConfig
LifecycleConfig	lifecycleConfig() Creates a new instance of LifecycleConfig
MetricsConfig	metricsConfig() Creates a new instance of MetricsConfig
String	namespace() CloudWatch namespace for KCL metrics.
ProcessorConfig	processorConfig() Creates a new instance of ProcessorConfig
RetrievalConfig	retrievalConfig() Creates a new instance of RetrievalConfig
String	tableName() Lease table name used for lease management and checkpointing.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigsBuilder

public ConfigsBuilder(@NonNull
                      String streamName,
                      @NonNull
                      String applicationName,
                      @NonNull
                      software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient,
                      @NonNull
                      software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient dynamoDBClient,
                      @NonNull
                      software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient cloudWatchClient,
                      @NonNull
                      String workerIdentifier,
                      @NonNull
                      ShardRecordProcessorFactory shardRecordProcessorFactory)

Constructor to initialize ConfigsBuilder with StreamName

Parameters:

streamName -

applicationName -

kinesisClient -

dynamoDBClient -

cloudWatchClient -

workerIdentifier -

shardRecordProcessorFactory -

ConfigsBuilder

public ConfigsBuilder(@NonNull
                      MultiStreamTracker multiStreamTracker,
                      @NonNull
                      String applicationName,
                      @NonNull
                      software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient,
                      @NonNull
                      software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient dynamoDBClient,
                      @NonNull
                      software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient cloudWatchClient,
                      @NonNull
                      String workerIdentifier,
                      @NonNull
                      ShardRecordProcessorFactory shardRecordProcessorFactory)

Constructor to initialize ConfigsBuilder with MultiStreamTracker

Parameters:

multiStreamTracker -

applicationName -

kinesisClient -

dynamoDBClient -

cloudWatchClient -

workerIdentifier -

shardRecordProcessorFactory -

Method Detail

tableName

public String tableName()

Lease table name used for lease management and checkpointing.

Returns:

DynamoDB table name

namespace

public String namespace()

CloudWatch namespace for KCL metrics.

Returns:

CloudWatch namespace

checkpointConfig

public CheckpointConfig checkpointConfig()

Creates a new instance of CheckpointConfig

Returns:

CheckpointConfig

coordinatorConfig

public CoordinatorConfig coordinatorConfig()

Creates a new instance of CoordinatorConfig

Returns:

CoordinatorConfig

leaseManagementConfig

public LeaseManagementConfig leaseManagementConfig()

Creates a new instance of LeaseManagementConfig

Returns:

LeaseManagementConfig

lifecycleConfig

public LifecycleConfig lifecycleConfig()

Creates a new instance of LifecycleConfig

Returns:

LifecycleConfig

metricsConfig

public MetricsConfig metricsConfig()

Creates a new instance of MetricsConfig

Returns:

MetricsConfig

processorConfig

public ProcessorConfig processorConfig()

Creates a new instance of ProcessorConfig

Returns:

ProcessorConfigConfig

retrievalConfig

public RetrievalConfig retrievalConfig()

Creates a new instance of RetrievalConfig

Returns:

RetrievalConfig