com.amazonaws.services.dynamodbv2.document.spec

Class DeleteItemSpec

java.lang.Object

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

com.amazonaws.services.dynamodbv2.document.spec.DeleteItemSpec

public class DeleteItemSpec
extends AbstractSpecWithPrimaryKey<DeleteItemRequest>

Full parameter specification for the DeleteItem API.

Constructor Summary

Constructors

Constructor and Description
DeleteItemSpec()

Method Summary

Modifier and Type	Method and Description
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()
Map<String,Object>	getValueMap()
void	setProgressListener(ProgressListener progressListener)
void	setRequestMetricCollector(RequestMetricCollector requestMetricCollector)
DeleteItemSpec	withConditionalOperator(ConditionalOperator conditionalOperator)
DeleteItemSpec	withConditionExpression(String conditionExpression)
DeleteItemSpec	withExpected(Collection<Expected> expected)
DeleteItemSpec	withExpected(Expected... expected)
DeleteItemSpec	withExpressionSpec(DeleteItemExpressionSpec xspec) Convenient method to specify expressions (and the associated name map and value map) via DeleteItemExpressionSpec.
DeleteItemSpec	withNameMap(Map<String,String> nameMap) Applicable only when an expression has been specified.
DeleteItemSpec	withPrimaryKey(KeyAttribute... components) Sets the primary key with the specified key components.
DeleteItemSpec	withPrimaryKey(PrimaryKey primaryKey) Sets the primary key.
DeleteItemSpec	withPrimaryKey(String hashKeyName, Object hashKeyValue) Sets the primary key with the specified hash-only key name and value.
DeleteItemSpec	withPrimaryKey(String hashKeyName, Object hashKeyValue, String rangeKeyName, Object rangeKeyValue) Sets the primary key with the specified hash key and range key.
DeleteItemSpec	withProgressListener(ProgressListener progressListener)
DeleteItemSpec	withRequestMetricCollector(RequestMetricCollector requestMetricCollector)
DeleteItemSpec	withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
DeleteItemSpec	withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
DeleteItemSpec	withReturnValues(ReturnValue returnValues)
DeleteItemSpec	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

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

Constructor Detail

DeleteItemSpec

public DeleteItemSpec()

Method Detail

withPrimaryKey

public DeleteItemSpec withPrimaryKey(KeyAttribute... components)

Description copied from class: AbstractSpecWithPrimaryKey

Sets the primary key with the specified key components.

Overrides:

withPrimaryKey in class AbstractSpecWithPrimaryKey<DeleteItemRequest>

withPrimaryKey

public DeleteItemSpec withPrimaryKey(PrimaryKey primaryKey)

Description copied from class: AbstractSpecWithPrimaryKey

Sets the primary key.

Overrides:

withPrimaryKey in class AbstractSpecWithPrimaryKey<DeleteItemRequest>

withPrimaryKey

public DeleteItemSpec 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<DeleteItemRequest>

withPrimaryKey

public DeleteItemSpec 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<DeleteItemRequest>

getExpected

public Collection<Expected> getExpected()

withExpected

public DeleteItemSpec withExpected(Expected... expected)

withExpected

public DeleteItemSpec withExpected(Collection<Expected> expected)

getConditionExpression

public String getConditionExpression()

withConditionExpression

public DeleteItemSpec withConditionExpression(String conditionExpression)

getNameMap

public Map<String,String> getNameMap()

withNameMap

public DeleteItemSpec 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 DeleteItemSpec 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()

withConditionalOperator

public DeleteItemSpec withConditionalOperator(ConditionalOperator conditionalOperator)

getReturnConsumedCapacity

public String getReturnConsumedCapacity()

withReturnConsumedCapacity

public DeleteItemSpec withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)

getReturnItemCollectionMetrics

public String getReturnItemCollectionMetrics()

withReturnItemCollectionMetrics

public DeleteItemSpec withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)

getReturnValues

public String getReturnValues()

withReturnValues

public DeleteItemSpec withReturnValues(ReturnValue returnValues)

withProgressListener

public DeleteItemSpec withProgressListener(ProgressListener progressListener)

withRequestMetricCollector

public DeleteItemSpec withRequestMetricCollector(RequestMetricCollector requestMetricCollector)

withExpressionSpec

@Beta
public DeleteItemSpec withExpressionSpec(DeleteItemExpressionSpec xspec)

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

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)