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

Annotation Type DynamoDbVersionAttribute

@Retention(RUNTIME)
@Target({FIELD,METHOD})
public @interface DynamoDbVersionAttribute

Annotation for marking a property as an optimistic locking version attribute.

Applied to the getter method or the class field for the class's version property. If the annotation is applied directly to the class field, the corresponding getter and setter must be declared in the same class.

Alternately, the meta-annotation DynamoDbVersioned may be used to annotate a custom annotation, or directly to the field/getter.

Only nullable, integral numeric types (e.g. Integer, Long) can be used as version properties. On a save() operation, the DynamoDbMapper will attempt to increment the version property and assert that the service's value matches the client's. New objects will be assigned a version of 1 when saved.

Note that for batchWrite, and by extension batchSave and batchDelete, no version checks are performed, as required by the DynamoDBClient.batchWriteItem(BatchWriteItemRequest) API.

See Also:

DynamoDbVersioned

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	attributeName	Optional parameter when the name of the attribute as stored in DynamoDB should differ from the name used by the getter / setter.

Element Detail

attributeName

String attributeName

Optional parameter when the name of the attribute as stored in DynamoDB should differ from the name used by the getter / setter.

Default:

""