public class DynamoDBMapperConfig extends Object
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, ConsistentReads.CONSISTENT.config()); // Force this save operation to use putItem rather than updateItem mapper.save(obj, SaveBehavior.CLOBBER.config()); // Save the object into a different table mapper.save(obj, new TableNameOverride("AnotherTable").config()); // Delete the object even if the version field is out of date mapper.delete(obj, SaveBehavior.CLOBBER.config());
Modifier and Type | Class and Description |
---|---|
static interface |
DynamoDBMapperConfig.BatchLoadRetryStrategy
DynamoDBMapper.batchLoad(Iterable, DynamoDBMapperConfig) breaks the requested items in batches of maximum size 100. |
static interface |
DynamoDBMapperConfig.BatchWriteRetryStrategy
DynamoDBMapper#batchWrite takes arbitrary number of save/delete requests
and breaks them into smaller chunks that can be accepted by the service
API.
|
static class |
DynamoDBMapperConfig.Builder
A fluent builder for DynamoDBMapperConfig objects.
|
static class |
DynamoDBMapperConfig.ConsistentReads
Enumeration of consistent read behavior.
|
static class |
DynamoDBMapperConfig.DefaultBatchLoadRetryStrategy
This is the default strategy.
|
static class |
DynamoDBMapperConfig.DefaultBatchWriteRetryStrategy
The default BatchWriteRetryStrategy which always retries on
UnprocessedItem up to a maximum number of times and use exponential
backoff with random scale factor.
|
static class |
DynamoDBMapperConfig.DefaultTableNameResolver
Default implementation of
DynamoDBMapperConfig.TableNameResolver that mimics the behavior
of DynamoDBMapper before the addition of DynamoDBMapperConfig.TableNameResolver . |
static class |
DynamoDBMapperConfig.NoRetryBatchLoadRetryStrategy
This strategy, like name suggests will not attempt any retries on Unprocessed keys
|
static interface |
DynamoDBMapperConfig.ObjectTableNameResolver
Interface for a strategy used to determine the table name of an object based on its class.
|
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. |
static interface |
DynamoDBMapperConfig.TableNameResolver
Interface for a strategy used to determine the table name of an object based on its class.
|
Modifier and Type | Field and Description |
---|---|
static DynamoDBMapperConfig |
DEFAULT
Default configuration; these defaults are also applied by the mapper
when only partial configurations are specified.
|
public static final DynamoDBMapperConfig DEFAULT
DynamoDBMapperConfig.SaveBehavior.UPDATE
,
DynamoDBMapperConfig.ConsistentReads.EVENTUAL
,
DynamoDBMapperConfig.PaginationLoadingStrategy.LAZY_LOADING
,
DynamoDBMapperConfig.DefaultTableNameResolver.INSTANCE
,
DynamoDBMapperConfig.DefaultBatchWriteRetryStrategy.INSTANCE
,
DynamoDBMapperConfig.DefaultBatchLoadRetryStrategy.INSTANCE
,
DynamoDBTypeConverterFactory.standard()
,
ConversionSchemas.DEFAULT
@Deprecated public DynamoDBMapperConfig(DynamoDBMapperConfig.SaveBehavior saveBehavior, DynamoDBMapperConfig.ConsistentReads consistentReads, DynamoDBMapperConfig.TableNameOverride tableNameOverride)
DynamoDBMapperConfig.Builder
builder()
@Deprecated public DynamoDBMapperConfig(DynamoDBMapperConfig.SaveBehavior saveBehavior, DynamoDBMapperConfig.ConsistentReads consistentReads, DynamoDBMapperConfig.TableNameOverride tableNameOverride, DynamoDBMapperConfig.PaginationLoadingStrategy paginationLoadingStrategy)
DynamoDBMapperConfig.Builder
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.builder()
@Deprecated public DynamoDBMapperConfig(DynamoDBMapperConfig.SaveBehavior saveBehavior, DynamoDBMapperConfig.ConsistentReads consistentReads, DynamoDBMapperConfig.TableNameOverride tableNameOverride, DynamoDBMapperConfig.PaginationLoadingStrategy paginationLoadingStrategy, RequestMetricCollector requestMetricCollector)
DynamoDBMapperConfig.Builder
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 collectorbuilder()
@Deprecated public DynamoDBMapperConfig(DynamoDBMapperConfig.SaveBehavior saveBehavior)
@Deprecated public DynamoDBMapperConfig(DynamoDBMapperConfig.ConsistentReads consistentReads)
@Deprecated public DynamoDBMapperConfig(DynamoDBMapperConfig.TableNameOverride tableNameOverride)
@Deprecated public DynamoDBMapperConfig(DynamoDBMapperConfig.TableNameResolver tableNameResolver)
builder()
@Deprecated public DynamoDBMapperConfig(DynamoDBMapperConfig.ObjectTableNameResolver objectTableNameResolver)
builder()
@Deprecated public DynamoDBMapperConfig(DynamoDBMapperConfig.TableNameResolver tableNameResolver, DynamoDBMapperConfig.ObjectTableNameResolver objectTableNameResolver)
builder()
@Deprecated public DynamoDBMapperConfig(DynamoDBMapperConfig.PaginationLoadingStrategy paginationLoadingStrategy)
@Deprecated public DynamoDBMapperConfig(ConversionSchema conversionSchema)
builder()
@Deprecated public DynamoDBMapperConfig(DynamoDBMapperConfig defaults, DynamoDBMapperConfig overrides)
Used internally to merge the DynamoDBMapperConfig
provided at
construction with an overriding object for a particular operation.
defaults
- The default mapper configuration values.overrides
- The overridden mapper configuration values. Any non-null
config settings will be applied to the returned object.builder()
public static final DynamoDBMapperConfig.Builder builder()
public DynamoDBMapperConfig.BatchLoadRetryStrategy getBatchLoadRetryStrategy()
public DynamoDBMapperConfig.SaveBehavior getSaveBehavior()
public DynamoDBMapperConfig.ConsistentReads getConsistentReads()
public DynamoDBMapperConfig.TableNameOverride getTableNameOverride()
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.public DynamoDBMapperConfig.TableNameResolver getTableNameResolver()
DynamoDBMapperConfig.TableNameOverride
.public DynamoDBMapperConfig.ObjectTableNameResolver getObjectTableNameResolver()
DynamoDBMapperConfig.TableNameOverride
.public DynamoDBMapperConfig.PaginationLoadingStrategy getPaginationLoadingStrategy()
public RequestMetricCollector getRequestMetricCollector()
public ConversionSchema getConversionSchema()
public DynamoDBMapperConfig.BatchWriteRetryStrategy getBatchWriteRetryStrategy()
public final DynamoDBTypeConverterFactory getTypeConverterFactory()