com.amazonaws.services.dynamodbv2.datamodeling

Class DynamoDBMapperConfig

java.lang.Object

com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapperConfig

public class DynamoDBMapperConfig
extends Object

Immutable configuration object for service call behavior. An instance of this configuration is supplied to every DynamoDBMapper at construction; if not provided explicitly, DEFAULT is used. New instances can be given to the mapper object on individual save, load, and delete operations to override the defaults. For example:

 DynamoDBMapper mapper = new DynamoDBMapper(dynamoDBClient);
 // Force this read to be consistent
 DomainClass obj = mapper.load(DomainClass.class, key, new DynamoDBMapperConfig(ConsistentReads.CONSISTENT));
 // Force this save operation to use putItem rather than updateItem
 mapper.save(obj, new DynamoDBMapperConfig(SaveBehavior.CLOBBER));
 // Save the object into a different table
 mapper.save(obj, new DynamoDBMapperConfig(new TableNameOverride("AnotherTable")));
 // Delete the object even if the version field is out of date
 mapper.delete(obj, new DynamoDBMapperConfig(SaveBehavior.CLOBBER));
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DynamoDBMapperConfig.ConsistentReads Enumeration of consistent read behavior.
static class	DynamoDBMapperConfig.PaginationLoadingStrategy Enumeration of pagination loading strategy.
static class	DynamoDBMapperConfig.SaveBehavior Enumeration of behaviors for the save operation.
static class	DynamoDBMapperConfig.TableNameOverride Allows overriding the table name declared on a domain class by the DynamoDBTable annotation.

Field Summary

Fields

Modifier and Type	Field and Description
static DynamoDBMapperConfig	DEFAULT Default configuration uses UPDATE behavior for saves and EVENTUALly consistent reads, with no table name override and lazy-loading strategy.

Constructor Summary

Constructors

Constructor and Description
DynamoDBMapperConfig(DynamoDBMapperConfig.ConsistentReads consistentReads) Constructs a new configuration object with the consistent read behavior given.
DynamoDBMapperConfig(DynamoDBMapperConfig.PaginationLoadingStrategy paginationLoadingStrategy) Constructs a new configuration object with the pagination loading strategy given.
DynamoDBMapperConfig(DynamoDBMapperConfig.SaveBehavior saveBehavior) Constructs a new configuration object with the save behavior given.
DynamoDBMapperConfig(DynamoDBMapperConfig.SaveBehavior saveBehavior, DynamoDBMapperConfig.ConsistentReads consistentReads, DynamoDBMapperConfig.TableNameOverride tableNameOverride) Legacy constructor, using default PaginationLoadingStrategy
DynamoDBMapperConfig(DynamoDBMapperConfig.SaveBehavior saveBehavior, DynamoDBMapperConfig.ConsistentReads consistentReads, DynamoDBMapperConfig.TableNameOverride tableNameOverride, DynamoDBMapperConfig.PaginationLoadingStrategy paginationLoadingStrategy) Constructs a new configuration object with the save behavior, consistent read behavior, and table name override given.
DynamoDBMapperConfig(DynamoDBMapperConfig.SaveBehavior saveBehavior, DynamoDBMapperConfig.ConsistentReads consistentReads, DynamoDBMapperConfig.TableNameOverride tableNameOverride, DynamoDBMapperConfig.PaginationLoadingStrategy paginationLoadingStrategy, RequestMetricCollector requestMetricCollector) Constructs a new configuration object with the save behavior, consistent read behavior, and table name override given.
DynamoDBMapperConfig(DynamoDBMapperConfig.TableNameOverride tableNameOverride) Constructs a new configuration object with the table name override given.

Method Summary

Methods

Modifier and Type	Method and Description
DynamoDBMapperConfig.ConsistentReads	getConsistentReads() Returns the consistent read behavior for this configuration.
DynamoDBMapperConfig.PaginationLoadingStrategy	getPaginationLoadingStrategy() Returns the pagination loading strategy for this configuration.
RequestMetricCollector	getRequestMetricCollector() Returns the request metric collector or null if not specified.
DynamoDBMapperConfig.SaveBehavior	getSaveBehavior() Returns the save behavior for this configuration.
DynamoDBMapperConfig.TableNameOverride	getTableNameOverride() Returns the table name override for this configuration.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final DynamoDBMapperConfig DEFAULT

Default configuration uses UPDATE behavior for saves and EVENTUALly consistent reads, with no table name override and lazy-loading strategy.

Constructor Detail

DynamoDBMapperConfig

public DynamoDBMapperConfig(DynamoDBMapperConfig.SaveBehavior saveBehavior,
                    DynamoDBMapperConfig.ConsistentReads consistentReads,
                    DynamoDBMapperConfig.TableNameOverride tableNameOverride)

Legacy constructor, using default PaginationLoadingStrategy

DynamoDBMapperConfig

public DynamoDBMapperConfig(DynamoDBMapperConfig.SaveBehavior saveBehavior,
                    DynamoDBMapperConfig.ConsistentReads consistentReads,
                    DynamoDBMapperConfig.TableNameOverride tableNameOverride,
                    DynamoDBMapperConfig.PaginationLoadingStrategy paginationLoadingStrategy)

Constructs a new configuration object with the save behavior, consistent read behavior, and table name override given.

Parameters:

saveBehavior - The DynamoDBMapperConfig.SaveBehavior to use, or null for default.

consistentReads - The DynamoDBMapperConfig.ConsistentReads to use, or null for default.

tableNameOverride - An override for the table name, or null for no override.

paginationLoadingStrategy - The pagination loading strategy, or null for default.

DynamoDBMapperConfig

public DynamoDBMapperConfig(DynamoDBMapperConfig.SaveBehavior saveBehavior,
                    DynamoDBMapperConfig.ConsistentReads consistentReads,
                    DynamoDBMapperConfig.TableNameOverride tableNameOverride,
                    DynamoDBMapperConfig.PaginationLoadingStrategy paginationLoadingStrategy,
                    RequestMetricCollector requestMetricCollector)

Constructs a new configuration object with the save behavior, consistent read behavior, and table name override given.

Parameters:

saveBehavior - The DynamoDBMapperConfig.SaveBehavior to use, or null for default.

consistentReads - The DynamoDBMapperConfig.ConsistentReads to use, or null for default.

tableNameOverride - An override for the table name, or null for no override.

paginationLoadingStrategy - The pagination loading strategy, or null for default.

requestMetricCollector - optional request metric collector

DynamoDBMapperConfig

public DynamoDBMapperConfig(DynamoDBMapperConfig.SaveBehavior saveBehavior)

Constructs a new configuration object with the save behavior given.

DynamoDBMapperConfig

public DynamoDBMapperConfig(DynamoDBMapperConfig.ConsistentReads consistentReads)

Constructs a new configuration object with the consistent read behavior given.

DynamoDBMapperConfig

public DynamoDBMapperConfig(DynamoDBMapperConfig.TableNameOverride tableNameOverride)

Constructs a new configuration object with the table name override given.

DynamoDBMapperConfig

public DynamoDBMapperConfig(DynamoDBMapperConfig.PaginationLoadingStrategy paginationLoadingStrategy)

Constructs a new configuration object with the pagination loading strategy given.

Method Detail

getSaveBehavior

public DynamoDBMapperConfig.SaveBehavior getSaveBehavior()

Returns the save behavior for this configuration.

getConsistentReads

public DynamoDBMapperConfig.ConsistentReads getConsistentReads()

Returns the consistent read behavior for this configuration.

getTableNameOverride

public DynamoDBMapperConfig.TableNameOverride getTableNameOverride()

Returns the table name override for this configuration. This value will override the table name specified in a DynamoDBTable annotation, either by replacing the table name entirely or else by pre-pending a string to each table name. This is useful for partitioning data in multiple tables at runtime.

See Also:

DynamoDBMapperConfig.TableNameOverride.withTableNamePrefix(String), DynamoDBMapperConfig.TableNameOverride.withTableNameReplacement(String)

getPaginationLoadingStrategy

public DynamoDBMapperConfig.PaginationLoadingStrategy getPaginationLoadingStrategy()

Returns the pagination loading strategy for this configuration.

getRequestMetricCollector

public RequestMetricCollector getRequestMetricCollector()

Returns the request metric collector or null if not specified.