Package software.amazon.awssdk.services.dynamodb.datamodeling

Class DynamoDbMapperConfig.Builder

java.lang.Object

software.amazon.awssdk.services.dynamodb.datamodeling.DynamoDbMapperConfig.Builder

Enclosing class:

DynamoDbMapperConfig

public static class DynamoDbMapperConfig.Builder
extends Object

A fluent builder for DynamoDBMapperConfig objects.

Constructor Summary

Constructors

Constructor	Description
Builder()	Creates a new builder initialized with the DynamoDbMapperConfig.DEFAULT values.

Method Summary

Modifier and Type	Method	Description
DynamoDbMapperConfig.BatchLoadRetryStrategy	batchLoadRetryStrategy()
DynamoDbMapperConfig.BatchWriteRetryStrategy	batchWriteRetryStrategy()
DynamoDbMapperConfig	build()	Builds a new DynamoDBMapperConfig object.
DynamoDbMapperConfig.ConsistentReads	getConsistentReads()	Returns the consistent read behavior.
ConversionSchema	getConversionSchema()
DynamoDbMapperConfig.ObjectTableNameResolver	getObjectTableNameResolver()
DynamoDbMapperConfig.PaginationLoadingStrategy	getPaginationLoadingStrategy()
RequestMetricCollector	getRequestMetricCollector()
DynamoDbMapperConfig.TableNameOverride	getTableNameOverride()
DynamoDbMapperConfig.TableNameResolver	getTableNameResolver()
DynamoDbTypeConverterFactory	getTypeConverterFactory()
DynamoDbMapperConfig.SaveBehavior	saveBehavior()
void	setBatchLoadRetryStrategy(DynamoDbMapperConfig.BatchLoadRetryStrategy value)
void	setBatchWriteRetryStrategy(DynamoDbMapperConfig.BatchWriteRetryStrategy value)
void	setConsistentReads(DynamoDbMapperConfig.ConsistentReads value)	Sets the consistent read behavior.
void	setConversionSchema(ConversionSchema value)
void	setObjectTableNameResolver(DynamoDbMapperConfig.ObjectTableNameResolver value)
void	setPaginationLoadingStrategy(DynamoDbMapperConfig.PaginationLoadingStrategy value)
void	setRequestMetricCollector(RequestMetricCollector value)
void	setSaveBehavior(DynamoDbMapperConfig.SaveBehavior value)
void	setTableNameOverride(DynamoDbMapperConfig.TableNameOverride value)
void	setTableNameResolver(DynamoDbMapperConfig.TableNameResolver value)
void	setTypeConverterFactory(DynamoDbTypeConverterFactory value)
DynamoDbMapperConfig.Builder	withBatchLoadRetryStrategy(DynamoDbMapperConfig.BatchLoadRetryStrategy value)
DynamoDbMapperConfig.Builder	withBatchWriteRetryStrategy(DynamoDbMapperConfig.BatchWriteRetryStrategy value)
DynamoDbMapperConfig.Builder	withConsistentReads(DynamoDbMapperConfig.ConsistentReads value)	Sets the consistent read behavior.
DynamoDbMapperConfig.Builder	withConversionSchema(ConversionSchema value)
DynamoDbMapperConfig.Builder	withObjectTableNameResolver(DynamoDbMapperConfig.ObjectTableNameResolver value)
DynamoDbMapperConfig.Builder	withPaginationLoadingStrategy(DynamoDbMapperConfig.PaginationLoadingStrategy value)
DynamoDbMapperConfig.Builder	withRequestMetricCollector(RequestMetricCollector value)
DynamoDbMapperConfig.Builder	withSaveBehavior(DynamoDbMapperConfig.SaveBehavior value)
DynamoDbMapperConfig.Builder	withTableNameOverride(DynamoDbMapperConfig.TableNameOverride value)
DynamoDbMapperConfig.Builder	withTableNameResolver(DynamoDbMapperConfig.TableNameResolver value)
DynamoDbMapperConfig.Builder	withTypeConverterFactory(DynamoDbTypeConverterFactory value)	The type-converter factory for scalar conversions.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Creates a new builder initialized with the DynamoDbMapperConfig.DEFAULT values.

Method Detail

saveBehavior

public DynamoDbMapperConfig.SaveBehavior saveBehavior()

Returns:

the currently-configured save behavior

setSaveBehavior

public void setSaveBehavior(DynamoDbMapperConfig.SaveBehavior value)

Parameters:

value - the new save behavior

withSaveBehavior

public DynamoDbMapperConfig.Builder withSaveBehavior(DynamoDbMapperConfig.SaveBehavior value)

Parameters:

value - the new save behavior

Returns:

this builder

getConsistentReads

public DynamoDbMapperConfig.ConsistentReads getConsistentReads()

Returns the consistent read behavior. Currently this value is applied only in load and batch load operations of the DynamoDBMapper.

Returns:

the currently-configured consistent read behavior.

setConsistentReads

public void setConsistentReads(DynamoDbMapperConfig.ConsistentReads value)

Sets the consistent read behavior. Currently this value is applied only in load and batch load operations of the DynamoDBMapper.

Parameters:

value - the new consistent read behavior.

withConsistentReads

public DynamoDbMapperConfig.Builder withConsistentReads(DynamoDbMapperConfig.ConsistentReads value)

Sets the consistent read behavior. Currently this value is applied only in load and batch load operations of the DynamoDBMapper.

Parameters:

value - the new consistent read behavior

Returns:

this builder.

getTableNameOverride

public DynamoDbMapperConfig.TableNameOverride getTableNameOverride()

Returns:

the current table name override

setTableNameOverride

public void setTableNameOverride(DynamoDbMapperConfig.TableNameOverride value)

Parameters:

value - the new table name override

withTableNameOverride

public DynamoDbMapperConfig.Builder withTableNameOverride(DynamoDbMapperConfig.TableNameOverride value)

Parameters:

value - the new table name override

Returns:

this builder

getTableNameResolver

public DynamoDbMapperConfig.TableNameResolver getTableNameResolver()

Returns:

the current table name resolver

setTableNameResolver

public void setTableNameResolver(DynamoDbMapperConfig.TableNameResolver value)

Parameters:

value - the new table name resolver

withTableNameResolver

public DynamoDbMapperConfig.Builder withTableNameResolver(DynamoDbMapperConfig.TableNameResolver value)

Parameters:

value - the new table name resolver

Returns:

this builder

getObjectTableNameResolver

public DynamoDbMapperConfig.ObjectTableNameResolver getObjectTableNameResolver()

Returns:

the current object table name resolver

setObjectTableNameResolver

public void setObjectTableNameResolver(DynamoDbMapperConfig.ObjectTableNameResolver value)

Parameters:

value - the new object table name resolver

withObjectTableNameResolver

public DynamoDbMapperConfig.Builder withObjectTableNameResolver(DynamoDbMapperConfig.ObjectTableNameResolver value)

Parameters:

value - the new object table name resolver

Returns:

this builder

getPaginationLoadingStrategy

public DynamoDbMapperConfig.PaginationLoadingStrategy getPaginationLoadingStrategy()

Returns:

the currently-configured pagination loading strategy

setPaginationLoadingStrategy

public void setPaginationLoadingStrategy(DynamoDbMapperConfig.PaginationLoadingStrategy value)

Parameters:

value - the new pagination loading strategy

withPaginationLoadingStrategy

public DynamoDbMapperConfig.Builder withPaginationLoadingStrategy(DynamoDbMapperConfig.PaginationLoadingStrategy value)

Parameters:

value - the new pagination loading strategy

Returns:

this builder

getRequestMetricCollector

public RequestMetricCollector getRequestMetricCollector()

Returns:

the currently-configured request metric collector

setRequestMetricCollector

public void setRequestMetricCollector(RequestMetricCollector value)

Parameters:

value - the new request metric collector

withRequestMetricCollector

public DynamoDbMapperConfig.Builder withRequestMetricCollector(RequestMetricCollector value)

Parameters:

value - the new request metric collector

Returns:

this builder

getConversionSchema

public ConversionSchema getConversionSchema()

Returns:

the current conversion schema

setConversionSchema

public void setConversionSchema(ConversionSchema value)

Parameters:

value - the new conversion schema

withConversionSchema

public DynamoDbMapperConfig.Builder withConversionSchema(ConversionSchema value)

Parameters:

value - the new conversion schema

Returns:

this builder

batchWriteRetryStrategy

public DynamoDbMapperConfig.BatchWriteRetryStrategy batchWriteRetryStrategy()

Returns:

the current BatchWriteRetryStrategy

setBatchWriteRetryStrategy

public void setBatchWriteRetryStrategy(DynamoDbMapperConfig.BatchWriteRetryStrategy value)

Parameters:

value - the new BatchWriteRetryStrategy

withBatchWriteRetryStrategy

public DynamoDbMapperConfig.Builder withBatchWriteRetryStrategy(DynamoDbMapperConfig.BatchWriteRetryStrategy value)

Parameters:

value - the new BatchWriteRetryStrategy

Returns:

this builder

batchLoadRetryStrategy

public DynamoDbMapperConfig.BatchLoadRetryStrategy batchLoadRetryStrategy()

setBatchLoadRetryStrategy

public void setBatchLoadRetryStrategy(DynamoDbMapperConfig.BatchLoadRetryStrategy value)

Parameters:

value - the new BatchLoadRetryStrategy

withBatchLoadRetryStrategy

public DynamoDbMapperConfig.Builder withBatchLoadRetryStrategy(DynamoDbMapperConfig.BatchLoadRetryStrategy value)

Parameters:

value - the new BatchLoadRetryStrategy

Returns:

this builder

getTypeConverterFactory

public final DynamoDbTypeConverterFactory getTypeConverterFactory()

Returns:

the current type-converter factory

setTypeConverterFactory

public final void setTypeConverterFactory(DynamoDbTypeConverterFactory value)

Parameters:

value - the new type-converter factory

withTypeConverterFactory

public final DynamoDbMapperConfig.Builder withTypeConverterFactory(DynamoDbTypeConverterFactory value)

The type-converter factory for scalar conversions.

To override standard type-conversions,

 DynamoDBMapperConfig config = DynamoDBMapperConfig.builder()
     .withTypeConverterFactory(DynamoDBTypeConverterFactory.standard().override()
         .with(String.class, MyObject.class, new StringToMyObjectConverter())
         .build())
     .build();
 

Then, on the property, specify the attribute binding,

 @DynamoDBTyped(DynamoDBAttributeType.S)
 public MyObject myObject()
 

Parameters:

value - the new type-converter factory

Returns:

this builder

build

public DynamoDbMapperConfig build()

Builds a new DynamoDBMapperConfig object.

Returns:

the new, immutable config object