com.amazonaws.services.dynamodbv2.document.spec.DeleteItemSpec Maven / Gradle / Ivy
/*
* Copyright 2014-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.dynamodbv2.document.spec;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;
import com.amazonaws.annotation.Beta;
import com.amazonaws.event.ProgressListener;
import com.amazonaws.metrics.RequestMetricCollector;
import com.amazonaws.services.dynamodbv2.document.Expected;
import com.amazonaws.services.dynamodbv2.document.KeyAttribute;
import com.amazonaws.services.dynamodbv2.document.PrimaryKey;
import com.amazonaws.services.dynamodbv2.model.ConditionalOperator;
import com.amazonaws.services.dynamodbv2.model.DeleteItemRequest;
import com.amazonaws.services.dynamodbv2.model.ReturnConsumedCapacity;
import com.amazonaws.services.dynamodbv2.model.ReturnItemCollectionMetrics;
import com.amazonaws.services.dynamodbv2.model.ReturnValue;
import com.amazonaws.services.dynamodbv2.xspec.DeleteItemExpressionSpec;
/**
* Full parameter specification for the DeleteItem API.
*/
public class DeleteItemSpec extends AbstractSpecWithPrimaryKey {
private Collection expected;
private Map nameMap;
private Map valueMap;
public DeleteItemSpec() {
super(new DeleteItemRequest());
}
@Override
public DeleteItemSpec withPrimaryKey(KeyAttribute ... components) {
super.withPrimaryKey(components);
return this;
}
@Override
public DeleteItemSpec withPrimaryKey(PrimaryKey primaryKey) {
super.withPrimaryKey(primaryKey);
return this;
}
@Override
public DeleteItemSpec withPrimaryKey(String hashKeyName, Object hashKeyValue) {
super.withPrimaryKey(hashKeyName, hashKeyValue);
return this;
}
@Override
public DeleteItemSpec withPrimaryKey(String hashKeyName, Object hashKeyValue,
String rangeKeyName, Object rangeKeyValue) {
super.withPrimaryKey(hashKeyName, hashKeyValue, rangeKeyName, rangeKeyValue);
return this;
}
public Collection getExpected() {
return expected;
}
public DeleteItemSpec withExpected(Expected ... expected) {
if (expected == null) {
this.expected = null;
return this;
}
return withExpected(Arrays.asList(expected));
}
public DeleteItemSpec withExpected(Collection expected) {
if (expected == null) {
this.expected = null;
return this;
}
Set names = new LinkedHashSet();
for (Expected e: expected)
names.add(e.getAttribute());
if (names.size() != expected.size()) {
throw new IllegalArgumentException(
"attribute names must not duplicate in the list of expected");
}
this.expected = Collections.unmodifiableCollection(expected);
return this;
}
public String getConditionExpression() {
return getRequest().getConditionExpression();
}
public DeleteItemSpec withConditionExpression(String conditionExpression) {
getRequest().setConditionExpression(conditionExpression);
return this;
}
public Map getNameMap() {
return 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.
*/
public DeleteItemSpec withNameMap(Map nameMap) {
if (nameMap == null) {
this.nameMap = null;
} else {
this.nameMap = Collections.unmodifiableMap(
new LinkedHashMap(nameMap));
}
return this;
}
public Map getValueMap() {
return valueMap;
}
/**
* Applicable only when an expression has been specified. Used to
* specify the actual values for the attribute-value placeholders.
*/
public DeleteItemSpec withValueMap(Map valueMap) {
if (valueMap == null) {
this.valueMap = null;
} else {
this.valueMap = Collections.unmodifiableMap(
new LinkedHashMap(valueMap));
}
return this;
}
public String getConditionalOperator() {
return getRequest().getConditionalOperator();
}
public DeleteItemSpec withConditionalOperator(ConditionalOperator conditionalOperator) {
getRequest().setConditionalOperator(conditionalOperator);
return this;
}
public String getReturnConsumedCapacity() {
return getRequest().getReturnConsumedCapacity();
}
public DeleteItemSpec withReturnConsumedCapacity(
ReturnConsumedCapacity returnConsumedCapacity) {
getRequest().setReturnConsumedCapacity(returnConsumedCapacity);
return this;
}
public String getReturnItemCollectionMetrics() {
return getRequest().getReturnItemCollectionMetrics();
}
public DeleteItemSpec withReturnItemCollectionMetrics(
ReturnItemCollectionMetrics returnItemCollectionMetrics) {
getRequest().setReturnItemCollectionMetrics(returnItemCollectionMetrics);
return this;
}
public String getReturnValues() {
return getRequest().getReturnValues();
}
public DeleteItemSpec withReturnValues(ReturnValue returnValues) {
getRequest().setReturnValues(returnValues);
return this;
}
@Override
public DeleteItemSpec withProgressListener(ProgressListener progressListener) {
setProgressListener(progressListener);
return this;
}
@Override
public DeleteItemSpec withRequestMetricCollector(
RequestMetricCollector requestMetricCollector) {
setRequestMetricCollector(requestMetricCollector);
return this;
}
/**
* Convenient method to specify expressions (and the associated name map and
* value map) via {@link DeleteItemExpressionSpec}.
*/
@Beta
public DeleteItemSpec withExpressionSpec(DeleteItemExpressionSpec xspec) {
return withConditionExpression(xspec.getConditionExpression())
.withNameMap(xspec.getNameMap())
.withValueMap(xspec.getValueMap())
;
}
}