Class PutBuilder<T>

java.lang.Object

dev.hogwai.dynamodb.simplified.builder.base.AbstractPutBuilder<T, PutBuilder<T>>

dev.hogwai.dynamodb.simplified.builder.PutBuilder<T>

Type Parameters:

T - the type of the item

public class PutBuilder<T>
extends AbstractPutBuilder<T, PutBuilder<T>>

A fluent builder for putting (inserting or replacing) an item in a DynamoDB table, with an optional condition expression. Part of the DynamoDB Simplified library.

Field Summary

Fields inherited from class AbstractPutBuilder

conditionExpression, item, LOG, optimisticLocking, returnValues

Constructor Summary

Constructors

Constructor	Description
PutBuilder(@NonNull software.amazon.awssdk.enhanced.dynamodb.DynamoDbTable<T> table, @NonNull T item, @NonNull software.amazon.awssdk.services.dynamodb.DynamoDbClient dynamoDbClient)	Constructs a new PutBuilder for the given table and item.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the put operation.
@NonNull Optional<T>	executeReturning()	Executes the put operation and returns the previous item if AbstractPutBuilder.returnValues(ReturnValue) was set to ALL_OLD.
protected @NonNull PutBuilder<T>	self()	Returns this typed as S for fluent chaining.
protected @NonNull String	tableName()	Returns the DynamoDB table name.

Methods inherited from class AbstractPutBuilder

applyOptimisticLocking, buildEnhancedRequest, buildLowLevelRequest, condition, condition, incrementVersion, onlyIfNotExists, returnValues, withOptimisticLocking

Methods inherited from class Object

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

Constructor Details

PutBuilder

public PutBuilder(@NonNull software.amazon.awssdk.enhanced.dynamodb.DynamoDbTable<T> table,
 @NonNull T item,
 @NonNull software.amazon.awssdk.services.dynamodb.DynamoDbClient dynamoDbClient)

Constructs a new PutBuilder for the given table and item.

Parameters:

table - the DynamoDB table

item - the item to put

dynamoDbClient - the low-level DynamoDB client (required for return values)

Method Details

self

protected @NonNull PutBuilder<T> self()

Description copied from class: AbstractPutBuilder

Returns this typed as S for fluent chaining.

Specified by:

self in class AbstractPutBuilder<T, PutBuilder<T>>

Returns:

this builder

execute

public void execute()

Executes the put operation.

executeReturning

public @NonNull Optional<T> executeReturning()

Executes the put operation and returns the previous item if AbstractPutBuilder.returnValues(ReturnValue) was set to ALL_OLD.

If no return value was configured, returns Optional.empty().

Returns:

the previous item (if ReturnValue.ALL_OLD was set), or empty if the item didn't previously exist or no return value was configured

tableName

protected @NonNull String tableName()

Description copied from class: AbstractPutBuilder

Returns the DynamoDB table name.

Specified by:

tableName in class AbstractPutBuilder<T, PutBuilder<T>>

Returns:

the DynamoDB table name