Class UpdateItemSpec
java.lang.Object
com.amazonaws.services.dynamodbv2.document.spec.AbstractSpecWithPrimaryKey<UpdateItemRequest>
com.amazonaws.services.dynamodbv2.document.spec.UpdateItemSpec
Full parameter specification for the UpdateItem API.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAttributeUpdate
(AttributeUpdate attributeUpdate) Internal method.void
setProgressListener
(ProgressListener progressListener) void
setRequestMetricCollector
(RequestMetricCollector requestMetricCollector) withAttributeUpdate
(AttributeUpdate... attributeUpdates) withAttributeUpdate
(List<AttributeUpdate> attributeUpdates) withConditionExpression
(String conditionExpression) withExpected
(Expected... expected) withExpected
(Collection<Expected> expected) Convenient method to specify expressions (and the associated name map and value map) viaUpdateItemExpressionSpec
.withNameMap
(Map<String, String> nameMap) Applicable only when an expression has been specified.withPrimaryKey
(KeyAttribute... components) Sets the primary key with the specified key components.withPrimaryKey
(PrimaryKey primaryKey) Sets the primary key.withPrimaryKey
(String hashKeyName, Object hashKeyValue) Sets the primary key with the specified hash-only key name and value.withPrimaryKey
(String hashKeyName, Object hashKeyValue, String rangeKeyName, Object rangeKeyValue) Sets the primary key with the specified hash key and range key.withProgressListener
(ProgressListener progressListener) withRequestMetricCollector
(RequestMetricCollector requestMetricCollector) withReturnConsumedCapacity
(ReturnConsumedCapacity returnConsumedCapacity) withReturnConsumedCapacity
(String returnConsumedCapacity) withReturnItemCollectionMetrics
(ReturnItemCollectionMetrics returnItemCollectionMetrics) withReturnItemCollectionMetrics
(String returnItemCollectionMetrics) withReturnValues
(ReturnValue returnValues) withReturnValues
(String returnValues) withUpdateExpression
(String updateExpression) withValueMap
(Map<String, Object> valueMap) Applicable only when an expression has been specified.Methods inherited from class com.amazonaws.services.dynamodbv2.document.spec.AbstractSpecWithPrimaryKey
getKeyComponents
-
Constructor Details
-
UpdateItemSpec
public UpdateItemSpec()
-
-
Method Details
-
withPrimaryKey
Description copied from class:AbstractSpecWithPrimaryKey
Sets the primary key with the specified key components.- Overrides:
withPrimaryKey
in classAbstractSpecWithPrimaryKey<UpdateItemRequest>
-
withPrimaryKey
Description copied from class:AbstractSpecWithPrimaryKey
Sets the primary key.- Overrides:
withPrimaryKey
in classAbstractSpecWithPrimaryKey<UpdateItemRequest>
-
withPrimaryKey
Description copied from class:AbstractSpecWithPrimaryKey
Sets the primary key with the specified hash-only key name and value.- Overrides:
withPrimaryKey
in classAbstractSpecWithPrimaryKey<UpdateItemRequest>
-
withPrimaryKey
public UpdateItemSpec withPrimaryKey(String hashKeyName, Object hashKeyValue, String rangeKeyName, Object rangeKeyValue) Description copied from class:AbstractSpecWithPrimaryKey
Sets the primary key with the specified hash key and range key.- Overrides:
withPrimaryKey
in classAbstractSpecWithPrimaryKey<UpdateItemRequest>
-
getAttributeUpdate
-
withAttributeUpdate
-
withAttributeUpdate
-
addAttributeUpdate
-
clearAttributeUpdate
-
getExpected
-
withExpected
-
withExpected
-
getUpdateExpression
-
withUpdateExpression
-
getConditionExpression
-
withConditionExpression
-
getNameMap
-
withNameMap
Applicable only when an expression has been specified. Used to specify the actual values for the attribute-name placeholders, where the value in the map can either be string for simple attribute name, or a JSON path expression. -
getValueMap
-
withValueMap
Applicable only when an expression has been specified. Used to specify the actual values for the attribute-value placeholders. -
getConditionalOperator
-
getReturnConsumedCapacity
-
withReturnConsumedCapacity
-
withReturnConsumedCapacity
-
getReturnItemCollectionMetrics
-
withReturnItemCollectionMetrics
public UpdateItemSpec withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics) -
withReturnItemCollectionMetrics
-
getReturnValues
-
withReturnValues
-
withReturnValues
-
withProgressListener
-
withRequestMetricCollector
-
withExpressionSpec
Convenient method to specify expressions (and the associated name map and value map) viaUpdateItemExpressionSpec
. -
getRequest
Internal method. Not meant to be called directly. May change without notice. -
getProgressListener
-
setProgressListener
-
getRequestMetricCollector
-
setRequestMetricCollector
-