com.amazonaws.services.dynamodbv2

Class AmazonDynamoDBLockClientOptions

java.lang.Object

com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClientOptions

public class AmazonDynamoDBLockClientOptions
extends Object

An options class for setting up a lock client with various overrides to the defaults. In order to use this, it must be constructed using the builder.

Author:

Sasha Slutsker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AmazonDynamoDBLockClientOptions.AmazonDynamoDBLockClientOptionsBuilder A builder for setting up an AmazonDynamoDBLockClientOptions object.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Boolean	DEFAULT_CREATE_HEARTBEAT_BACKGROUND_THREAD
protected static Long	DEFAULT_HEARTBEAT_PERIOD
protected static Boolean	DEFAULT_HOLD_LOCK_ON_SERVICE_UNAVAILABLE
protected static Long	DEFAULT_LEASE_DURATION
protected static String	DEFAULT_PARTITION_KEY_NAME
protected static TimeUnit	DEFAULT_TIME_UNIT

Method Summary

Modifier and Type	Method and Description
static AmazonDynamoDBLockClientOptions.AmazonDynamoDBLockClientOptionsBuilder	builder(software.amazon.awssdk.services.dynamodb.DynamoDbClient dynamoDBClient, String tableName) Creates an AmazonDynamoDBLockClientOptions builder object, which can be used to create an AmazonDynamoDBLockClient.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PARTITION_KEY_NAME

protected static final String DEFAULT_PARTITION_KEY_NAME

See Also:

Constant Field Values

DEFAULT_LEASE_DURATION

protected static final Long DEFAULT_LEASE_DURATION

DEFAULT_HEARTBEAT_PERIOD

protected static final Long DEFAULT_HEARTBEAT_PERIOD

DEFAULT_TIME_UNIT

protected static final TimeUnit DEFAULT_TIME_UNIT

DEFAULT_CREATE_HEARTBEAT_BACKGROUND_THREAD

protected static final Boolean DEFAULT_CREATE_HEARTBEAT_BACKGROUND_THREAD

DEFAULT_HOLD_LOCK_ON_SERVICE_UNAVAILABLE

protected static final Boolean DEFAULT_HOLD_LOCK_ON_SERVICE_UNAVAILABLE

Method Detail

builder

public static AmazonDynamoDBLockClientOptions.AmazonDynamoDBLockClientOptionsBuilder builder(software.amazon.awssdk.services.dynamodb.DynamoDbClient dynamoDBClient,
                                                                                             String tableName)

Creates an AmazonDynamoDBLockClientOptions builder object, which can be used to create an AmazonDynamoDBLockClient. The only required parameters are the client and the table name.

Parameters:

dynamoDBClient - The client for talking to DynamoDB.

tableName - The table containing the lock client.

Returns:

A builder which can be used for creating a lock client.