software.amazon.kinesis.leases

Class LeaseManagementConfig

java.lang.Object

software.amazon.kinesis.leases.LeaseManagementConfig

public class LeaseManagementConfig
extends Object

Used by the KCL to configure lease management.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_COMPLETED_LEASE_CLEANUP_INTERVAL_MILLIS
static int	DEFAULT_CONSECUTIVE_HOLES_FOR_TRIGGERING_LEASE_RECOVERY
static long	DEFAULT_GARBAGE_LEASE_CLEANUP_INTERVAL_MILLIS
static LeaseCleanupConfig	DEFAULT_LEASE_CLEANUP_CONFIG
static long	DEFAULT_LEASE_CLEANUP_INTERVAL_MILLIS
static long	DEFAULT_PERIODIC_SHARD_SYNC_INTERVAL_MILLIS
static Duration	DEFAULT_REQUEST_TIMEOUT
long	epsilonMillis

Constructor Summary

Constructors

Constructor and Description
LeaseManagementConfig(String tableName, software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient dynamoDBClient, software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient, String workerIdentifier)
LeaseManagementConfig(String tableName, software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient dynamoDBClient, software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient, String streamName, String workerIdentifier) Deprecated.

Method Summary

Modifier and Type	Method and Description
HierarchicalShardSyncer	hierarchicalShardSyncer()
LeaseManagementFactory	leaseManagementFactory() Deprecated.
LeaseManagementConfig	leaseManagementFactory(LeaseManagementFactory leaseManagementFactory) Set leaseManagementFactory and return the current LeaseManagementConfig instance.
LeaseManagementFactory	leaseManagementFactory(LeaseSerializer leaseSerializer, boolean isMultiStreamingMode) Vends LeaseManagementFactory that performs serde based on leaseSerializer and shard sync based on isMultiStreamingMode
MetricsFactory	metricsFactory() Deprecated.
LeaseManagementConfig	metricsFactory(MetricsFactory metricsFactory) Deprecated.

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_LEASE_CLEANUP_INTERVAL_MILLIS

public static final long DEFAULT_LEASE_CLEANUP_INTERVAL_MILLIS

DEFAULT_COMPLETED_LEASE_CLEANUP_INTERVAL_MILLIS

public static final long DEFAULT_COMPLETED_LEASE_CLEANUP_INTERVAL_MILLIS

DEFAULT_GARBAGE_LEASE_CLEANUP_INTERVAL_MILLIS

public static final long DEFAULT_GARBAGE_LEASE_CLEANUP_INTERVAL_MILLIS

DEFAULT_PERIODIC_SHARD_SYNC_INTERVAL_MILLIS

public static final long DEFAULT_PERIODIC_SHARD_SYNC_INTERVAL_MILLIS

See Also:

Constant Field Values

DEFAULT_CONSECUTIVE_HOLES_FOR_TRIGGERING_LEASE_RECOVERY

public static final int DEFAULT_CONSECUTIVE_HOLES_FOR_TRIGGERING_LEASE_RECOVERY

See Also:

Constant Field Values

DEFAULT_LEASE_CLEANUP_CONFIG

public static final LeaseCleanupConfig DEFAULT_LEASE_CLEANUP_CONFIG

epsilonMillis

public long epsilonMillis

Constructor Detail

LeaseManagementConfig

@Deprecated
public LeaseManagementConfig(String tableName,
                                         software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient dynamoDBClient,
                                         software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient,
                                         String streamName,
                                         String workerIdentifier)

Deprecated.

LeaseManagementConfig

public LeaseManagementConfig(String tableName,
                             software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient dynamoDBClient,
                             software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisClient,
                             String workerIdentifier)

Method Detail

metricsFactory

@Deprecated
public MetricsFactory metricsFactory()

Deprecated.

Returns the metrics factory.

NOTE: This method is deprecated and will be removed in a future release. This metrics factory is not being used in the KCL.

Returns:

metricsFactory

@Deprecated
public LeaseManagementConfig metricsFactory(MetricsFactory metricsFactory)

Deprecated.

Sets the metrics factory.

NOTE: This method is deprecated and will be removed in a future release. This metrics factory is not being used in the KCL.

Parameters:

metricsFactory -

hierarchicalShardSyncer

public HierarchicalShardSyncer hierarchicalShardSyncer()

leaseManagementFactory

@Deprecated
public LeaseManagementFactory leaseManagementFactory()

Deprecated.

leaseManagementFactory

public LeaseManagementFactory leaseManagementFactory(LeaseSerializer leaseSerializer,
                                                     boolean isMultiStreamingMode)

Vends LeaseManagementFactory that performs serde based on leaseSerializer and shard sync based on isMultiStreamingMode

Parameters:

leaseSerializer -

isMultiStreamingMode -

Returns:

LeaseManagementFactory

leaseManagementFactory

public LeaseManagementConfig leaseManagementFactory(LeaseManagementFactory leaseManagementFactory)

Set leaseManagementFactory and return the current LeaseManagementConfig instance.

Parameters:

leaseManagementFactory -

Returns:

LeaseManagementConfig