com.amazon.ask.attributes.persistence.impl

Class DynamoDbPersistenceAdapter.Builder

java.lang.Object

com.amazon.ask.attributes.persistence.impl.DynamoDbPersistenceAdapter.Builder

Enclosing class:

DynamoDbPersistenceAdapter

public static final class DynamoDbPersistenceAdapter.Builder
extends Object

Static builder class to build an instance of DynamoDbPersistenceAdapter.

Method Summary

Modifier and Type	Method and Description
DynamoDbPersistenceAdapter	build() Builder method to build an instance of DynamoDbPersistenceAdapter.
DynamoDbPersistenceAdapter.Builder	withAttributesKeyName(String attributesKeyName) Optional name of the attributes key.
DynamoDbPersistenceAdapter.Builder	withAutoCreateTable(boolean autoCreateTable) Optional flag specifying whether the adapter should automatically create a table with the configured name if it does not already exist.
DynamoDbPersistenceAdapter.Builder	withDynamoDbClient(com.amazonaws.services.dynamodbv2.AmazonDynamoDB dynamoDb) Optional DynamoDB client instance to use.
DynamoDbPersistenceAdapter.Builder	withPartitionKeyGenerator(Function<RequestEnvelope,String> partitionKeyGenerator) Optional partition key generator function used to derive partition key value from one or more attributes of a RequestEnvelope.
DynamoDbPersistenceAdapter.Builder	withPartitionKeyName(String partitionKeyName) Optional name of the partition key used to key attributes.
DynamoDbPersistenceAdapter.Builder	withTableName(String tableName) Name of the DynamoDB table to use for storing Skill persistence attributes.

Methods inherited from class java.lang.Object

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

Method Detail

withDynamoDbClient

public DynamoDbPersistenceAdapter.Builder withDynamoDbClient(com.amazonaws.services.dynamodbv2.AmazonDynamoDB dynamoDb)

Optional DynamoDB client instance to use. If not provided, a default DynamoDB client instance will be constructed and used.

Parameters:

dynamoDb - client instance

Returns:

builder

withTableName

public DynamoDbPersistenceAdapter.Builder withTableName(String tableName)

Name of the DynamoDB table to use for storing Skill persistence attributes.

Parameters:

tableName - name of the DynamoDB table to use

Returns:

builder

withPartitionKeyName

public DynamoDbPersistenceAdapter.Builder withPartitionKeyName(String partitionKeyName)

Optional name of the partition key used to key attributes. By default is used.

Parameters:

partitionKeyName - name of the partition key

Returns:

builder

withAttributesKeyName

public DynamoDbPersistenceAdapter.Builder withAttributesKeyName(String attributesKeyName)

Optional name of the attributes key. By default is used.

Parameters:

attributesKeyName - name of the attribute key

Returns:

builder

withPartitionKeyGenerator

public DynamoDbPersistenceAdapter.Builder withPartitionKeyGenerator(Function<RequestEnvelope,String> partitionKeyGenerator)

Optional partition key generator function used to derive partition key value from one or more attributes of a RequestEnvelope. By default, PartitionKeyGenerators.userId() is used.

Parameters:

partitionKeyGenerator - partition key generator function

Returns:

builder

withAutoCreateTable

public DynamoDbPersistenceAdapter.Builder withAutoCreateTable(boolean autoCreateTable)

Optional flag specifying whether the adapter should automatically create a table with the configured name if it does not already exist. If not specified, this behavior defaults to true.

Parameters:

autoCreateTable - true if the table should be automatically created if it does not already exist

Returns:

builder

build

public DynamoDbPersistenceAdapter build()

Builder method to build an instance of DynamoDbPersistenceAdapter.

Returns:

DynamoDbPersistenceAdapter.