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(@NonNull software.amazon.awssdk.arns.Arn streamArn, @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 for a single stream identified by Arn.
ConfigsBuilder(@NonNull StreamTracker streamTracker, @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
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 for a single stream identified by name.

Method Summary

Modifier and Type	Method and Description
void	appStreamTracker(software.amazon.awssdk.utils.Either<MultiStreamTracker,String> appStreamTracker)
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
void	streamTracker(StreamTracker streamTracker)
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
                      @NonNull String streamName,
                      @NonNull
                      @NonNull String applicationName,
                      @NonNull
                      @NonNull software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient,
                      @NonNull
                      @NonNull software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient dynamoDBClient,
                      @NonNull
                      @NonNull software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient cloudWatchClient,
                      @NonNull
                      @NonNull String workerIdentifier,
                      @NonNull
                      @NonNull ShardRecordProcessorFactory shardRecordProcessorFactory)

Constructor to initialize ConfigsBuilder for a single stream identified by name.

Parameters:

streamName -

applicationName -

kinesisClient -

dynamoDBClient -

cloudWatchClient -

workerIdentifier -

shardRecordProcessorFactory -

ConfigsBuilder

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

Constructor to initialize ConfigsBuilder for a single stream identified by Arn.

Parameters:

streamArn -

applicationName -

kinesisClient -

dynamoDBClient -

cloudWatchClient -

workerIdentifier -

shardRecordProcessorFactory -

ConfigsBuilder

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

Constructor to initialize ConfigsBuilder

Parameters:

streamTracker - tracker for single- or multi-stream processing

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

appStreamTracker

public void appStreamTracker(software.amazon.awssdk.utils.Either<MultiStreamTracker,String> appStreamTracker)

streamTracker

public void streamTracker(StreamTracker streamTracker)

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