com.amazonaws.services.dynamodbv2.document.spec

Class UpdateItemSpec

java.lang.Object

com.amazonaws.services.dynamodbv2.document.spec.AbstractSpecWithPrimaryKey<UpdateItemRequest>

com.amazonaws.services.dynamodbv2.document.spec.UpdateItemSpec

public class UpdateItemSpec
extends AbstractSpecWithPrimaryKey<UpdateItemRequest>

Full parameter specification for the UpdateItem API.

Constructor Summary

Constructors

Constructor and Description
UpdateItemSpec()

Method Summary

Modifier and Type	Method and Description
UpdateItemSpec	addAttributeUpdate(AttributeUpdate attributeUpdate)
UpdateItemSpec	clearAttributeUpdate()
List<AttributeUpdate>	getAttributeUpdate()
String	getConditionalOperator()
String	getConditionExpression()
Collection<Expected>	getExpected()
Map<String,String>	getNameMap()
ProgressListener	getProgressListener()
T	getRequest() Internal method.
RequestMetricCollector	getRequestMetricCollector()
String	getReturnConsumedCapacity()
String	getReturnItemCollectionMetrics()
String	getReturnValues()
String	getUpdateExpression()
Map<String,Object>	getValueMap()
void	setProgressListener(ProgressListener progressListener)
void	setRequestMetricCollector(RequestMetricCollector requestMetricCollector)
UpdateItemSpec	withAttributeUpdate(AttributeUpdate... attributeUpdates)
UpdateItemSpec	withAttributeUpdate(List<AttributeUpdate> attributeUpdates)
UpdateItemSpec	withConditionExpression(String conditionExpression)
UpdateItemSpec	withExpected(Collection<Expected> expected)
UpdateItemSpec	withExpected(Expected... expected)
UpdateItemSpec	withExpressionSpec(UpdateItemExpressionSpec xspec) Convenient method to specify expressions (and the associated name map and value map) via UpdateItemExpressionSpec.
UpdateItemSpec	withNameMap(Map<String,String> nameMap) Applicable only when an expression has been specified.
UpdateItemSpec	withPrimaryKey(KeyAttribute... components) Sets the primary key with the specified key components.
UpdateItemSpec	withPrimaryKey(PrimaryKey primaryKey) Sets the primary key.
UpdateItemSpec	withPrimaryKey(String hashKeyName, Object hashKeyValue) Sets the primary key with the specified hash-only key name and value.
UpdateItemSpec	withPrimaryKey(String hashKeyName, Object hashKeyValue, String rangeKeyName, Object rangeKeyValue) Sets the primary key with the specified hash key and range key.
UpdateItemSpec	withProgressListener(ProgressListener progressListener)
UpdateItemSpec	withRequestMetricCollector(RequestMetricCollector requestMetricCollector)
UpdateItemSpec	withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
UpdateItemSpec	withReturnConsumedCapacity(String returnConsumedCapacity)
UpdateItemSpec	withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
UpdateItemSpec	withReturnItemCollectionMetrics(String returnItemCollectionMetrics)
UpdateItemSpec	withReturnValues(ReturnValue returnValues)
UpdateItemSpec	withReturnValues(String returnValues)
UpdateItemSpec	withUpdateExpression(String updateExpression)
UpdateItemSpec	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

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateItemSpec

public UpdateItemSpec()

Method Detail

withPrimaryKey

public UpdateItemSpec withPrimaryKey(KeyAttribute... components)

Description copied from class: AbstractSpecWithPrimaryKey

Sets the primary key with the specified key components.

Overrides:

withPrimaryKey in class AbstractSpecWithPrimaryKey<UpdateItemRequest>

withPrimaryKey

public UpdateItemSpec withPrimaryKey(PrimaryKey primaryKey)

Description copied from class: AbstractSpecWithPrimaryKey

Sets the primary key.

Overrides:

withPrimaryKey in class AbstractSpecWithPrimaryKey<UpdateItemRequest>

withPrimaryKey

public UpdateItemSpec withPrimaryKey(String hashKeyName,
                                     Object hashKeyValue)

Description copied from class: AbstractSpecWithPrimaryKey

Sets the primary key with the specified hash-only key name and value.

Overrides:

withPrimaryKey in class AbstractSpecWithPrimaryKey<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 class AbstractSpecWithPrimaryKey<UpdateItemRequest>

getAttributeUpdate

public List<AttributeUpdate> getAttributeUpdate()

withAttributeUpdate

public UpdateItemSpec withAttributeUpdate(List<AttributeUpdate> attributeUpdates)

withAttributeUpdate

public UpdateItemSpec withAttributeUpdate(AttributeUpdate... attributeUpdates)

addAttributeUpdate

public UpdateItemSpec addAttributeUpdate(AttributeUpdate attributeUpdate)

clearAttributeUpdate

public UpdateItemSpec clearAttributeUpdate()

getExpected

public Collection<Expected> getExpected()

withExpected

public UpdateItemSpec withExpected(Expected... expected)

withExpected

public UpdateItemSpec withExpected(Collection<Expected> expected)

getUpdateExpression

public String getUpdateExpression()

withUpdateExpression

public UpdateItemSpec withUpdateExpression(String updateExpression)

getConditionExpression

public String getConditionExpression()

withConditionExpression

public UpdateItemSpec withConditionExpression(String conditionExpression)

getNameMap

public Map<String,String> getNameMap()

withNameMap

public UpdateItemSpec withNameMap(Map<String,String> nameMap)

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

public Map<String,Object> getValueMap()

withValueMap

public UpdateItemSpec withValueMap(Map<String,Object> valueMap)

Applicable only when an expression has been specified. Used to specify the actual values for the attribute-value placeholders.

getConditionalOperator

public String getConditionalOperator()

getReturnConsumedCapacity

public String getReturnConsumedCapacity()

withReturnConsumedCapacity

public UpdateItemSpec withReturnConsumedCapacity(String returnConsumedCapacity)

withReturnConsumedCapacity

public UpdateItemSpec withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)

getReturnItemCollectionMetrics

public String getReturnItemCollectionMetrics()

withReturnItemCollectionMetrics

public UpdateItemSpec withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)

withReturnItemCollectionMetrics

public UpdateItemSpec withReturnItemCollectionMetrics(String returnItemCollectionMetrics)

getReturnValues

public String getReturnValues()

withReturnValues

public UpdateItemSpec withReturnValues(ReturnValue returnValues)

withReturnValues

public UpdateItemSpec withReturnValues(String returnValues)

withProgressListener

public UpdateItemSpec withProgressListener(ProgressListener progressListener)

withRequestMetricCollector

public UpdateItemSpec withRequestMetricCollector(RequestMetricCollector requestMetricCollector)

withExpressionSpec

@Beta
public UpdateItemSpec withExpressionSpec(UpdateItemExpressionSpec xspec)

Convenient method to specify expressions (and the associated name map and value map) via UpdateItemExpressionSpec.

getRequest

public T getRequest()

Internal method. Not meant to be called directly. May change without notice.

getProgressListener

public ProgressListener getProgressListener()

setProgressListener

public void setProgressListener(ProgressListener progressListener)

getRequestMetricCollector

public RequestMetricCollector getRequestMetricCollector()

setRequestMetricCollector

public void setRequestMetricCollector(RequestMetricCollector requestMetricCollector)