/* * Copyright 2018-2023 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.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *

* Represents the input of a PutItem operation. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class PutItemRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The name of the table to contain the item. *

*/ private String tableName; /** *

* A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you * can optionally provide other attribute name-value pairs for the item. *

*

* You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need * to provide a value for the partition key. For a composite primary key, you must provide both values for both the * partition key and the sort key. *

*

* If you specify any attributes that are part of an index key, then the data types for those attributes must match * those of the schema in the table's attribute definition. *

*

* Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a * length greater than zero if the attribute is used as a key attribute for a table or index. *

*

* For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide. *

*

* Each element in the Item map is an AttributeValue object. *

*/ private java.util.Map item; /** *

* This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide. *

*/ private java.util.Map expected; /** *

* Use ReturnValues if you want to get the item attributes as they appeared before they were updated * with the PutItem request. For PutItem, the valid values are: *

* *

* The values returned are strongly consistent. *

*

* There is no additional cost associated with requesting a return value aside from the small network and processing * overhead of receiving a larger response. No read capacity units are consumed. *

* *

* The ReturnValues parameter is used by several DynamoDB operations; however, PutItem * does not recognize any values other than NONE or ALL_OLD. *

* */ private String returnValues; private String returnConsumedCapacity; /** *

* Determines whether item collection metrics are returned. If set to SIZE, the response includes * statistics about item collections, if any, that were modified during the operation are returned in the response. * If set to NONE (the default), no statistics are returned. *

*/ private String returnItemCollectionMetrics; /** *

* This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. *

*/ private String conditionalOperator; /** *

* A condition that must be satisfied in order for a conditional PutItem operation to succeed. *

*

* An expression can contain any of the following: *

* *

* For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide. *

*/ private String conditionExpression; /** *

* One or more substitution tokens for attribute names in an expression. The following are some use cases for using * ExpressionAttributeNames: *

* *

* Use the # character in an expression to dereference an attribute name. For example, consider the following * attribute name: *

* *

* The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For * the complete list of reserved words, see Reserved Words in * the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for * ExpressionAttributeNames: *

* *

* You could then use this substitution in an expression, as in this example: *

* * *

* Tokens that begin with the : character are expression attribute values, which are placeholders for * the actual value at runtime. *

* *

* For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide. *

*/ private java.util.Map expressionAttributeNames; /** *

* One or more values that can be substituted in an expression. *

*

* Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that * you wanted to check whether the value of the ProductStatus attribute was one of the following: *

*

* Available | Backordered | Discontinued *

*

* You would first need to specify ExpressionAttributeValues as follows: *

*

* { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } *

*

* You could then use these values in an expression, such as this: *

*

* ProductStatus IN (:avail, :back, :disc) *

*

* For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide. *

*/ private java.util.Map expressionAttributeValues; /** *

* An optional parameter that returns the item attributes for a PutItem operation that failed a * condition check. *

*

* There is no additional cost associated with requesting a return value aside from the small network and processing * overhead of receiving a larger response. No read capacity units are consumed. *

*/ private String returnValuesOnConditionCheckFailure; /** * Default constructor for PutItemRequest object. Callers should use the setter or fluent setter (with...) methods * to initialize the object after creating it. */ public PutItemRequest() { } /** * Constructs a new PutItemRequest object. Callers should use the setter or fluent setter (with...) methods to * initialize any additional object members. * * @param tableName * The name of the table to contain the item. * @param item * A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; * you can optionally provide other attribute name-value pairs for the item.

*

* You must provide all of the attributes for the primary key. For example, with a simple primary key, you * only need to provide a value for the partition key. For a composite primary key, you must provide both * values for both the partition key and the sort key. *

*

* If you specify any attributes that are part of an index key, then the data types for those attributes must * match those of the schema in the table's attribute definition. *

*

* Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have * a length greater than zero if the attribute is used as a key attribute for a table or index. *

*

* For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide. *

*

* Each element in the Item map is an AttributeValue object. */ public PutItemRequest(String tableName, java.util.Map item) { setTableName(tableName); setItem(item); } /** * Constructs a new PutItemRequest object. Callers should use the setter or fluent setter (with...) methods to * initialize any additional object members. * * @param tableName * The name of the table to contain the item. * @param item * A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; * you can optionally provide other attribute name-value pairs for the item.

*

* You must provide all of the attributes for the primary key. For example, with a simple primary key, you * only need to provide a value for the partition key. For a composite primary key, you must provide both * values for both the partition key and the sort key. *

*

* If you specify any attributes that are part of an index key, then the data types for those attributes must * match those of the schema in the table's attribute definition. *

*

* Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have * a length greater than zero if the attribute is used as a key attribute for a table or index. *

*

* For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide. *

*

* Each element in the Item map is an AttributeValue object. * @param returnValues * Use ReturnValues if you want to get the item attributes as they appeared before they were * updated with the PutItem request. For PutItem, the valid values are: *

*
    *
  • *

    * NONE - If ReturnValues is not specified, or if its value is NONE, * then nothing is returned. (This setting is the default for ReturnValues.) *

    *
    • *
  • *

    * ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of * the old item is returned. *

    *
    • *
*

* The values returned are strongly consistent. *

*

* There is no additional cost associated with requesting a return value aside from the small network and * processing overhead of receiving a larger response. No read capacity units are consumed. *

* *

* The ReturnValues parameter is used by several DynamoDB operations; however, * PutItem does not recognize any values other than NONE or ALL_OLD. *

*/ public PutItemRequest(String tableName, java.util.Map item, String returnValues) { setTableName(tableName); setItem(item); setReturnValues(returnValues); } /** * Constructs a new PutItemRequest object. Callers should use the setter or fluent setter (with...) methods to * initialize any additional object members. * * @param tableName * The name of the table to contain the item. * @param item * A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; * you can optionally provide other attribute name-value pairs for the item.

*

* You must provide all of the attributes for the primary key. For example, with a simple primary key, you * only need to provide a value for the partition key. For a composite primary key, you must provide both * values for both the partition key and the sort key. *

*

* If you specify any attributes that are part of an index key, then the data types for those attributes must * match those of the schema in the table's attribute definition. *

*

* Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have * a length greater than zero if the attribute is used as a key attribute for a table or index. *

*

* For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide. *

*

* Each element in the Item map is an AttributeValue object. * @param returnValues * Use ReturnValues if you want to get the item attributes as they appeared before they were * updated with the PutItem request. For PutItem, the valid values are: *

*
    *
  • *

    * NONE - If ReturnValues is not specified, or if its value is NONE, * then nothing is returned. (This setting is the default for ReturnValues.) *

    *
    • *
  • *

    * ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of * the old item is returned. *

    *
    • *
*

* The values returned are strongly consistent. *

*

* There is no additional cost associated with requesting a return value aside from the small network and * processing overhead of receiving a larger response. No read capacity units are consumed. *

* *

* The ReturnValues parameter is used by several DynamoDB operations; however, * PutItem does not recognize any values other than NONE or ALL_OLD. *

*/ public PutItemRequest(String tableName, java.util.Map item, ReturnValue returnValues) { setTableName(tableName); setItem(item); setReturnValues(returnValues.toString()); } /** *

* The name of the table to contain the item. *

* * @param tableName * The name of the table to contain the item. */ public void setTableName(String tableName) { this.tableName = tableName; } /** *

* The name of the table to contain the item. *

* * @return The name of the table to contain the item. */ public String getTableName() { return this.tableName; } /** *

* The name of the table to contain the item. *

* * @param tableName * The name of the table to contain the item. * @return Returns a reference to this object so that method calls can be chained together. */ public PutItemRequest withTableName(String tableName) { setTableName(tableName); return this; } /** *

* A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you * can optionally provide other attribute name-value pairs for the item. *

*

* You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need * to provide a value for the partition key. For a composite primary key, you must provide both values for both the * partition key and the sort key. *

*

* If you specify any attributes that are part of an index key, then the data types for those attributes must match * those of the schema in the table's attribute definition. *

*

* Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a * length greater than zero if the attribute is used as a key attribute for a table or index. *

*

* For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide. *

*

* Each element in the Item map is an AttributeValue object. *

* * @return A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are * required; you can optionally provide other attribute name-value pairs for the item.

*

* You must provide all of the attributes for the primary key. For example, with a simple primary key, you * only need to provide a value for the partition key. For a composite primary key, you must provide both * values for both the partition key and the sort key. *

*

* If you specify any attributes that are part of an index key, then the data types for those attributes * must match those of the schema in the table's attribute definition. *

*

* Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must * have a length greater than zero if the attribute is used as a key attribute for a table or index. *

*

* For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide. *

*

* Each element in the Item map is an AttributeValue object. */ public java.util.Map getItem() { return item; } /** *

* A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you * can optionally provide other attribute name-value pairs for the item. *

*

* You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need * to provide a value for the partition key. For a composite primary key, you must provide both values for both the * partition key and the sort key. *

*

* If you specify any attributes that are part of an index key, then the data types for those attributes must match * those of the schema in the table's attribute definition. *

*

* Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a * length greater than zero if the attribute is used as a key attribute for a table or index. *

*

* For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide. *

*

* Each element in the Item map is an AttributeValue object. *

* * @param item * A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; * you can optionally provide other attribute name-value pairs for the item.

*

* You must provide all of the attributes for the primary key. For example, with a simple primary key, you * only need to provide a value for the partition key. For a composite primary key, you must provide both * values for both the partition key and the sort key. *

*

* If you specify any attributes that are part of an index key, then the data types for those attributes must * match those of the schema in the table's attribute definition. *

*

* Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have * a length greater than zero if the attribute is used as a key attribute for a table or index. *

*

* For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide. *

*

* Each element in the Item map is an AttributeValue object. */ public void setItem(java.util.Map item) { this.item = item; } /** *

* A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you * can optionally provide other attribute name-value pairs for the item. *

*

* You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need * to provide a value for the partition key. For a composite primary key, you must provide both values for both the * partition key and the sort key. *

*

* If you specify any attributes that are part of an index key, then the data types for those attributes must match * those of the schema in the table's attribute definition. *

*

* Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a * length greater than zero if the attribute is used as a key attribute for a table or index. *

*

* For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide. *

*

* Each element in the Item map is an AttributeValue object. *

* * @param item * A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; * you can optionally provide other attribute name-value pairs for the item.

*

* You must provide all of the attributes for the primary key. For example, with a simple primary key, you * only need to provide a value for the partition key. For a composite primary key, you must provide both * values for both the partition key and the sort key. *

*

* If you specify any attributes that are part of an index key, then the data types for those attributes must * match those of the schema in the table's attribute definition. *

*

* Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have * a length greater than zero if the attribute is used as a key attribute for a table or index. *

*

* For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide. *

*

* Each element in the Item map is an AttributeValue object. * @return Returns a reference to this object so that method calls can be chained together. */ public PutItemRequest withItem(java.util.Map item) { setItem(item); return this; } /** * Add a single Item entry * * @see PutItemRequest#withItem * @returns a reference to this object so that method calls can be chained together. */ public PutItemRequest addItemEntry(String key, AttributeValue value) { if (null == this.item) { this.item = new java.util.HashMap(); } if (this.item.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.item.put(key, value); return this; } /** * Removes all the entries added into Item. * * @return Returns a reference to this object so that method calls can be chained together. */ public PutItemRequest clearItemEntries() { this.item = null; return this; } /** *

* This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide. *

* * @return This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide. */ public java.util.Map getExpected() { return expected; } /** *

* This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide. *

* * @param expected * This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide. */ public void setExpected(java.util.Map expected) { this.expected = expected; } /** *

* This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide. *

* * @param expected * This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public PutItemRequest withExpected(java.util.Map expected) { setExpected(expected); return this; } /** * Add a single Expected entry * * @see PutItemRequest#withExpected * @returns a reference to this object so that method calls can be chained together. */ public PutItemRequest addExpectedEntry(String key, ExpectedAttributeValue value) { if (null == this.expected) { this.expected = new java.util.HashMap(); } if (this.expected.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.expected.put(key, value); return this; } /** * Removes all the entries added into Expected. * * @return Returns a reference to this object so that method calls can be chained together. */ public PutItemRequest clearExpectedEntries() { this.expected = null; return this; } /** *

* Use ReturnValues if you want to get the item attributes as they appeared before they were updated * with the PutItem request. For PutItem, the valid values are: *

*
    *
  • *

    * NONE - If ReturnValues is not specified, or if its value is NONE, then * nothing is returned. (This setting is the default for ReturnValues.) *

    *
    • *
  • *

    * ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the * old item is returned. *

    *
    • *
*

* The values returned are strongly consistent. *

*

* There is no additional cost associated with requesting a return value aside from the small network and processing * overhead of receiving a larger response. No read capacity units are consumed. *

* *

* The ReturnValues parameter is used by several DynamoDB operations; however, PutItem * does not recognize any values other than NONE or ALL_OLD. *

* * * @param returnValues * Use ReturnValues if you want to get the item attributes as they appeared before they were * updated with the PutItem request. For PutItem, the valid values are:

*
    *
  • *

    * NONE - If ReturnValues is not specified, or if its value is NONE, * then nothing is returned. (This setting is the default for ReturnValues.) *

    *
    • *
  • *

    * ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of * the old item is returned. *

    *
    • *
*

* The values returned are strongly consistent. *

*

* There is no additional cost associated with requesting a return value aside from the small network and * processing overhead of receiving a larger response. No read capacity units are consumed. *

* *

* The ReturnValues parameter is used by several DynamoDB operations; however, * PutItem does not recognize any values other than NONE or ALL_OLD. *

* @see ReturnValue */ public void setReturnValues(String returnValues) { this.returnValues = returnValues; } /** *

* Use ReturnValues if you want to get the item attributes as they appeared before they were updated * with the PutItem request. For PutItem, the valid values are: *

*
    *
  • *

    * NONE - If ReturnValues is not specified, or if its value is NONE, then * nothing is returned. (This setting is the default for ReturnValues.) *

    *
    • *
  • *

    * ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the * old item is returned. *

    *
    • *
*

* The values returned are strongly consistent. *

*

* There is no additional cost associated with requesting a return value aside from the small network and processing * overhead of receiving a larger response. No read capacity units are consumed. *

* *

* The ReturnValues parameter is used by several DynamoDB operations; however, PutItem * does not recognize any values other than NONE or ALL_OLD. *

* * * @return Use ReturnValues if you want to get the item attributes as they appeared before they were * updated with the PutItem request. For PutItem, the valid values are:

*
    *
  • *

    * NONE - If ReturnValues is not specified, or if its value is NONE, * then nothing is returned. (This setting is the default for ReturnValues.) *

    *
    • *
  • *

    * ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content * of the old item is returned. *

    *
    • *
*

* The values returned are strongly consistent. *

*

* There is no additional cost associated with requesting a return value aside from the small network and * processing overhead of receiving a larger response. No read capacity units are consumed. *

* *

* The ReturnValues parameter is used by several DynamoDB operations; however, * PutItem does not recognize any values other than NONE or ALL_OLD. *

* @see ReturnValue */ public String getReturnValues() { return this.returnValues; } /** *

* Use ReturnValues if you want to get the item attributes as they appeared before they were updated * with the PutItem request. For PutItem, the valid values are: *

*
    *
  • *

    * NONE - If ReturnValues is not specified, or if its value is NONE, then * nothing is returned. (This setting is the default for ReturnValues.) *

    *
    • *
  • *

    * ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the * old item is returned. *

    *
    • *
*

* The values returned are strongly consistent. *

*

* There is no additional cost associated with requesting a return value aside from the small network and processing * overhead of receiving a larger response. No read capacity units are consumed. *

* *

* The ReturnValues parameter is used by several DynamoDB operations; however, PutItem * does not recognize any values other than NONE or ALL_OLD. *

* * * @param returnValues * Use ReturnValues if you want to get the item attributes as they appeared before they were * updated with the PutItem request. For PutItem, the valid values are:

*
    *
  • *

    * NONE - If ReturnValues is not specified, or if its value is NONE, * then nothing is returned. (This setting is the default for ReturnValues.) *

    *
    • *
  • *

    * ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of * the old item is returned. *

    *
    • *
*

* The values returned are strongly consistent. *

*

* There is no additional cost associated with requesting a return value aside from the small network and * processing overhead of receiving a larger response. No read capacity units are consumed. *

* *

* The ReturnValues parameter is used by several DynamoDB operations; however, * PutItem does not recognize any values other than NONE or ALL_OLD. *

* @return Returns a reference to this object so that method calls can be chained together. * @see ReturnValue */ public PutItemRequest withReturnValues(String returnValues) { setReturnValues(returnValues); return this; } /** *

* Use ReturnValues if you want to get the item attributes as they appeared before they were updated * with the PutItem request. For PutItem, the valid values are: *

*
    *
  • *

    * NONE - If ReturnValues is not specified, or if its value is NONE, then * nothing is returned. (This setting is the default for ReturnValues.) *

    *
    • *
  • *

    * ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the * old item is returned. *

    *
    • *
*

* The values returned are strongly consistent. *

*

* There is no additional cost associated with requesting a return value aside from the small network and processing * overhead of receiving a larger response. No read capacity units are consumed. *

* *

* The ReturnValues parameter is used by several DynamoDB operations; however, PutItem * does not recognize any values other than NONE or ALL_OLD. *

* * * @param returnValues * Use ReturnValues if you want to get the item attributes as they appeared before they were * updated with the PutItem request. For PutItem, the valid values are:

*
    *
  • *

    * NONE - If ReturnValues is not specified, or if its value is NONE, * then nothing is returned. (This setting is the default for ReturnValues.) *

    *
    • *
  • *

    * ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of * the old item is returned. *

    *
    • *
*

* The values returned are strongly consistent. *

*

* There is no additional cost associated with requesting a return value aside from the small network and * processing overhead of receiving a larger response. No read capacity units are consumed. *

* *

* The ReturnValues parameter is used by several DynamoDB operations; however, * PutItem does not recognize any values other than NONE or ALL_OLD. *

* @see ReturnValue */ public void setReturnValues(ReturnValue returnValues) { withReturnValues(returnValues); } /** *

* Use ReturnValues if you want to get the item attributes as they appeared before they were updated * with the PutItem request. For PutItem, the valid values are: *

*
    *
  • *

    * NONE - If ReturnValues is not specified, or if its value is NONE, then * nothing is returned. (This setting is the default for ReturnValues.) *

    *
    • *
  • *

    * ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the * old item is returned. *

    *
    • *
*

* The values returned are strongly consistent. *

*

* There is no additional cost associated with requesting a return value aside from the small network and processing * overhead of receiving a larger response. No read capacity units are consumed. *

* *

* The ReturnValues parameter is used by several DynamoDB operations; however, PutItem * does not recognize any values other than NONE or ALL_OLD. *

* * * @param returnValues * Use ReturnValues if you want to get the item attributes as they appeared before they were * updated with the PutItem request. For PutItem, the valid values are:

*
    *
  • *

    * NONE - If ReturnValues is not specified, or if its value is NONE, * then nothing is returned. (This setting is the default for ReturnValues.) *

    *
    • *
  • *

    * ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of * the old item is returned. *

    *
    • *
*

* The values returned are strongly consistent. *

*

* There is no additional cost associated with requesting a return value aside from the small network and * processing overhead of receiving a larger response. No read capacity units are consumed. *

* *

* The ReturnValues parameter is used by several DynamoDB operations; however, * PutItem does not recognize any values other than NONE or ALL_OLD. *

* @return Returns a reference to this object so that method calls can be chained together. * @see ReturnValue */ public PutItemRequest withReturnValues(ReturnValue returnValues) { this.returnValues = returnValues.toString(); return this; } /** * @param returnConsumedCapacity * @see ReturnConsumedCapacity */ public void setReturnConsumedCapacity(String returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity; } /** * @return * @see ReturnConsumedCapacity */ public String getReturnConsumedCapacity() { return this.returnConsumedCapacity; } /** * @param returnConsumedCapacity * @return Returns a reference to this object so that method calls can be chained together. * @see ReturnConsumedCapacity */ public PutItemRequest withReturnConsumedCapacity(String returnConsumedCapacity) { setReturnConsumedCapacity(returnConsumedCapacity); return this; } /** * @param returnConsumedCapacity * @see ReturnConsumedCapacity */ public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) { withReturnConsumedCapacity(returnConsumedCapacity); } /** * @param returnConsumedCapacity * @return Returns a reference to this object so that method calls can be chained together. * @see ReturnConsumedCapacity */ public PutItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity.toString(); return this; } /** *

* Determines whether item collection metrics are returned. If set to SIZE, the response includes * statistics about item collections, if any, that were modified during the operation are returned in the response. * If set to NONE (the default), no statistics are returned. *

* * @param returnItemCollectionMetrics * Determines whether item collection metrics are returned. If set to SIZE, the response * includes statistics about item collections, if any, that were modified during the operation are returned * in the response. If set to NONE (the default), no statistics are returned. * @see ReturnItemCollectionMetrics */ public void setReturnItemCollectionMetrics(String returnItemCollectionMetrics) { this.returnItemCollectionMetrics = returnItemCollectionMetrics; } /** *

* Determines whether item collection metrics are returned. If set to SIZE, the response includes * statistics about item collections, if any, that were modified during the operation are returned in the response. * If set to NONE (the default), no statistics are returned. *

* * @return Determines whether item collection metrics are returned. If set to SIZE, the response * includes statistics about item collections, if any, that were modified during the operation are returned * in the response. If set to NONE (the default), no statistics are returned. * @see ReturnItemCollectionMetrics */ public String getReturnItemCollectionMetrics() { return this.returnItemCollectionMetrics; } /** *

* Determines whether item collection metrics are returned. If set to SIZE, the response includes * statistics about item collections, if any, that were modified during the operation are returned in the response. * If set to NONE (the default), no statistics are returned. *

* * @param returnItemCollectionMetrics * Determines whether item collection metrics are returned. If set to SIZE, the response * includes statistics about item collections, if any, that were modified during the operation are returned * in the response. If set to NONE (the default), no statistics are returned. * @return Returns a reference to this object so that method calls can be chained together. * @see ReturnItemCollectionMetrics */ public PutItemRequest withReturnItemCollectionMetrics(String returnItemCollectionMetrics) { setReturnItemCollectionMetrics(returnItemCollectionMetrics); return this; } /** *

* Determines whether item collection metrics are returned. If set to SIZE, the response includes * statistics about item collections, if any, that were modified during the operation are returned in the response. * If set to NONE (the default), no statistics are returned. *

* * @param returnItemCollectionMetrics * Determines whether item collection metrics are returned. If set to SIZE, the response * includes statistics about item collections, if any, that were modified during the operation are returned * in the response. If set to NONE (the default), no statistics are returned. * @see ReturnItemCollectionMetrics */ public void setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics) { withReturnItemCollectionMetrics(returnItemCollectionMetrics); } /** *

* Determines whether item collection metrics are returned. If set to SIZE, the response includes * statistics about item collections, if any, that were modified during the operation are returned in the response. * If set to NONE (the default), no statistics are returned. *

* * @param returnItemCollectionMetrics * Determines whether item collection metrics are returned. If set to SIZE, the response * includes statistics about item collections, if any, that were modified during the operation are returned * in the response. If set to NONE (the default), no statistics are returned. * @return Returns a reference to this object so that method calls can be chained together. * @see ReturnItemCollectionMetrics */ public PutItemRequest withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics) { this.returnItemCollectionMetrics = returnItemCollectionMetrics.toString(); return this; } /** *

* This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. *

* * @param conditionalOperator * This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. * @see ConditionalOperator */ public void setConditionalOperator(String conditionalOperator) { this.conditionalOperator = conditionalOperator; } /** *

* This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. *

* * @return This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. * @see ConditionalOperator */ public String getConditionalOperator() { return this.conditionalOperator; } /** *

* This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. *

* * @param conditionalOperator * This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. * @see ConditionalOperator */ public PutItemRequest withConditionalOperator(String conditionalOperator) { setConditionalOperator(conditionalOperator); return this; } /** *

* This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. *

* * @param conditionalOperator * This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. * @see ConditionalOperator */ public void setConditionalOperator(ConditionalOperator conditionalOperator) { withConditionalOperator(conditionalOperator); } /** *

* This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. *

* * @param conditionalOperator * This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. * @see ConditionalOperator */ public PutItemRequest withConditionalOperator(ConditionalOperator conditionalOperator) { this.conditionalOperator = conditionalOperator.toString(); return this; } /** *

* A condition that must be satisfied in order for a conditional PutItem operation to succeed. *

*

* An expression can contain any of the following: *

*
    *
  • *

    * Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size *

    *

    * These function names are case-sensitive. *

    *
    • *
  • *

    * Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN *

    *
    • *
  • *

    * Logical operators: AND | OR | NOT *

    *
    • *
*

* For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide. *

* * @param conditionExpression * A condition that must be satisfied in order for a conditional PutItem operation to * succeed.

*

* An expression can contain any of the following: *

*
    *
  • *

    * Functions: * attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size *

    *

    * These function names are case-sensitive. *

    *
    • *
  • *

    * Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN *

    *
    • *
  • *

    * Logical operators: AND | OR | NOT *

    *
    • *
*

* For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide. */ public void setConditionExpression(String conditionExpression) { this.conditionExpression = conditionExpression; } /** *

* A condition that must be satisfied in order for a conditional PutItem operation to succeed. *

*

* An expression can contain any of the following: *

*
    *
  • *

    * Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size *

    *

    * These function names are case-sensitive. *

    *
    • *
  • *

    * Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN *

    *
    • *
  • *

    * Logical operators: AND | OR | NOT *

    *
    • *
*

* For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide. *

* * @return A condition that must be satisfied in order for a conditional PutItem operation to * succeed.

*

* An expression can contain any of the following: *

*
    *
  • *

    * Functions: * attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size *

    *

    * These function names are case-sensitive. *

    *
    • *
  • *

    * Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN *

    *
    • *
  • *

    * Logical operators: AND | OR | NOT *

    *
    • *
*

* For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide. */ public String getConditionExpression() { return this.conditionExpression; } /** *

* A condition that must be satisfied in order for a conditional PutItem operation to succeed. *

*

* An expression can contain any of the following: *

*
    *
  • *

    * Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size *

    *

    * These function names are case-sensitive. *

    *
    • *
  • *

    * Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN *

    *
    • *
  • *

    * Logical operators: AND | OR | NOT *

    *
    • *
*

* For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide. *

* * @param conditionExpression * A condition that must be satisfied in order for a conditional PutItem operation to * succeed.

*

* An expression can contain any of the following: *

*
    *
  • *

    * Functions: * attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size *

    *

    * These function names are case-sensitive. *

    *
    • *
  • *

    * Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN *

    *
    • *
  • *

    * Logical operators: AND | OR | NOT *

    *
    • *
*

* For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public PutItemRequest withConditionExpression(String conditionExpression) { setConditionExpression(conditionExpression); return this; } /** *

* One or more substitution tokens for attribute names in an expression. The following are some use cases for using * ExpressionAttributeNames: *

*
    *
  • *

    * To access an attribute whose name conflicts with a DynamoDB reserved word. *

    *
    • *
  • *

    * To create a placeholder for repeating occurrences of an attribute name in an expression. *

    *
    • *
  • *

    * To prevent special characters in an attribute name from being misinterpreted in an expression. *

    *
    • *
*

* Use the # character in an expression to dereference an attribute name. For example, consider the following * attribute name: *

*
    *
  • *

    * Percentile *

    *
    • *
*

* The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For * the complete list of reserved words, see Reserved Words in * the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for * ExpressionAttributeNames: *

*
    *
  • *

    * {"#P":"Percentile"} *

    *
    • *
*

* You could then use this substitution in an expression, as in this example: *

*
    *
  • *

    * #P = :val *

    *
    • *
* *

* Tokens that begin with the : character are expression attribute values, which are placeholders for * the actual value at runtime. *

* *

* For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide. *

* * @return One or more substitution tokens for attribute names in an expression. The following are some use cases * for using ExpressionAttributeNames:

*
    *
  • *

    * To access an attribute whose name conflicts with a DynamoDB reserved word. *

    *
    • *
  • *

    * To create a placeholder for repeating occurrences of an attribute name in an expression. *

    *
    • *
  • *

    * To prevent special characters in an attribute name from being misinterpreted in an expression. *

    *
    • *
*

* Use the # character in an expression to dereference an attribute name. For example, consider the * following attribute name: *

*
    *
  • *

    * Percentile *

    *
    • *
*

* The name of this attribute conflicts with a reserved word, so it cannot be used directly in an * expression. (For the complete list of reserved words, see Reserved * Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the * following for ExpressionAttributeNames: *

*
    *
  • *

    * {"#P":"Percentile"} *

    *
    • *
*

* You could then use this substitution in an expression, as in this example: *

*
    *
  • *

    * #P = :val *

    *
    • *
* *

* Tokens that begin with the : character are expression attribute values, which are * placeholders for the actual value at runtime. *

* *

* For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide. */ public java.util.Map getExpressionAttributeNames() { return expressionAttributeNames; } /** *

* One or more substitution tokens for attribute names in an expression. The following are some use cases for using * ExpressionAttributeNames: *

*
    *
  • *

    * To access an attribute whose name conflicts with a DynamoDB reserved word. *

    *
    • *
  • *

    * To create a placeholder for repeating occurrences of an attribute name in an expression. *

    *
    • *
  • *

    * To prevent special characters in an attribute name from being misinterpreted in an expression. *

    *
    • *
*

* Use the # character in an expression to dereference an attribute name. For example, consider the following * attribute name: *

*
    *
  • *

    * Percentile *

    *
    • *
*

* The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For * the complete list of reserved words, see Reserved Words in * the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for * ExpressionAttributeNames: *

*
    *
  • *

    * {"#P":"Percentile"} *

    *
    • *
*

* You could then use this substitution in an expression, as in this example: *

*
    *
  • *

    * #P = :val *

    *
    • *
* *

* Tokens that begin with the : character are expression attribute values, which are placeholders for * the actual value at runtime. *

* *

* For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide. *

* * @param expressionAttributeNames * One or more substitution tokens for attribute names in an expression. The following are some use cases for * using ExpressionAttributeNames:

*
    *
  • *

    * To access an attribute whose name conflicts with a DynamoDB reserved word. *

    *
    • *
  • *

    * To create a placeholder for repeating occurrences of an attribute name in an expression. *

    *
    • *
  • *

    * To prevent special characters in an attribute name from being misinterpreted in an expression. *

    *
    • *
*

* Use the # character in an expression to dereference an attribute name. For example, consider the * following attribute name: *

*
    *
  • *

    * Percentile *

    *
    • *
*

* The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. * (For the complete list of reserved words, see Reserved * Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the * following for ExpressionAttributeNames: *

*
    *
  • *

    * {"#P":"Percentile"} *

    *
    • *
*

* You could then use this substitution in an expression, as in this example: *

*
    *
  • *

    * #P = :val *

    *
    • *
* *

* Tokens that begin with the : character are expression attribute values, which are * placeholders for the actual value at runtime. *

* *

* For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide. */ public void setExpressionAttributeNames(java.util.Map expressionAttributeNames) { this.expressionAttributeNames = expressionAttributeNames; } /** *

* One or more substitution tokens for attribute names in an expression. The following are some use cases for using * ExpressionAttributeNames: *

*
    *
  • *

    * To access an attribute whose name conflicts with a DynamoDB reserved word. *

    *
    • *
  • *

    * To create a placeholder for repeating occurrences of an attribute name in an expression. *

    *
    • *
  • *

    * To prevent special characters in an attribute name from being misinterpreted in an expression. *

    *
    • *
*

* Use the # character in an expression to dereference an attribute name. For example, consider the following * attribute name: *

*
    *
  • *

    * Percentile *

    *
    • *
*

* The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For * the complete list of reserved words, see Reserved Words in * the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for * ExpressionAttributeNames: *

*
    *
  • *

    * {"#P":"Percentile"} *

    *
    • *
*

* You could then use this substitution in an expression, as in this example: *

*
    *
  • *

    * #P = :val *

    *
    • *
* *

* Tokens that begin with the : character are expression attribute values, which are placeholders for * the actual value at runtime. *

* *

* For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide. *

* * @param expressionAttributeNames * One or more substitution tokens for attribute names in an expression. The following are some use cases for * using ExpressionAttributeNames:

*
    *
  • *

    * To access an attribute whose name conflicts with a DynamoDB reserved word. *

    *
    • *
  • *

    * To create a placeholder for repeating occurrences of an attribute name in an expression. *

    *
    • *
  • *

    * To prevent special characters in an attribute name from being misinterpreted in an expression. *

    *
    • *
*

* Use the # character in an expression to dereference an attribute name. For example, consider the * following attribute name: *

*
    *
  • *

    * Percentile *

    *
    • *
*

* The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. * (For the complete list of reserved words, see Reserved * Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the * following for ExpressionAttributeNames: *

*
    *
  • *

    * {"#P":"Percentile"} *

    *
    • *
*

* You could then use this substitution in an expression, as in this example: *

*
    *
  • *

    * #P = :val *

    *
    • *
* *

* Tokens that begin with the : character are expression attribute values, which are * placeholders for the actual value at runtime. *

* *

* For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public PutItemRequest withExpressionAttributeNames(java.util.Map expressionAttributeNames) { setExpressionAttributeNames(expressionAttributeNames); return this; } /** * Add a single ExpressionAttributeNames entry * * @see PutItemRequest#withExpressionAttributeNames * @returns a reference to this object so that method calls can be chained together. */ public PutItemRequest addExpressionAttributeNamesEntry(String key, String value) { if (null == this.expressionAttributeNames) { this.expressionAttributeNames = new java.util.HashMap(); } if (this.expressionAttributeNames.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.expressionAttributeNames.put(key, value); return this; } /** * Removes all the entries added into ExpressionAttributeNames. * * @return Returns a reference to this object so that method calls can be chained together. */ public PutItemRequest clearExpressionAttributeNamesEntries() { this.expressionAttributeNames = null; return this; } /** *

* One or more values that can be substituted in an expression. *

*

* Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that * you wanted to check whether the value of the ProductStatus attribute was one of the following: *

*

* Available | Backordered | Discontinued *

*

* You would first need to specify ExpressionAttributeValues as follows: *

*

* { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } *

*

* You could then use these values in an expression, such as this: *

*

* ProductStatus IN (:avail, :back, :disc) *

*

* For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide. *

* * @return One or more values that can be substituted in an expression.

*

* Use the : (colon) character in an expression to dereference an attribute value. For example, * suppose that you wanted to check whether the value of the ProductStatus attribute was one of the * following: *

*

* Available | Backordered | Discontinued *

*

* You would first need to specify ExpressionAttributeValues as follows: *

*

* { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } *

*

* You could then use these values in an expression, such as this: *

*

* ProductStatus IN (:avail, :back, :disc) *

*

* For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide. */ public java.util.Map getExpressionAttributeValues() { return expressionAttributeValues; } /** *

* One or more values that can be substituted in an expression. *

*

* Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that * you wanted to check whether the value of the ProductStatus attribute was one of the following: *

*

* Available | Backordered | Discontinued *

*

* You would first need to specify ExpressionAttributeValues as follows: *

*

* { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } *

*

* You could then use these values in an expression, such as this: *

*

* ProductStatus IN (:avail, :back, :disc) *

*

* For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide. *

* * @param expressionAttributeValues * One or more values that can be substituted in an expression.

*

* Use the : (colon) character in an expression to dereference an attribute value. For example, * suppose that you wanted to check whether the value of the ProductStatus attribute was one of the * following: *

*

* Available | Backordered | Discontinued *

*

* You would first need to specify ExpressionAttributeValues as follows: *

*

* { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } *

*

* You could then use these values in an expression, such as this: *

*

* ProductStatus IN (:avail, :back, :disc) *

*

* For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide. */ public void setExpressionAttributeValues(java.util.Map expressionAttributeValues) { this.expressionAttributeValues = expressionAttributeValues; } /** *

* One or more values that can be substituted in an expression. *

*

* Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that * you wanted to check whether the value of the ProductStatus attribute was one of the following: *

*

* Available | Backordered | Discontinued *

*

* You would first need to specify ExpressionAttributeValues as follows: *

*

* { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } *

*

* You could then use these values in an expression, such as this: *

*

* ProductStatus IN (:avail, :back, :disc) *

*

* For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide. *

* * @param expressionAttributeValues * One or more values that can be substituted in an expression.

*

* Use the : (colon) character in an expression to dereference an attribute value. For example, * suppose that you wanted to check whether the value of the ProductStatus attribute was one of the * following: *

*

* Available | Backordered | Discontinued *

*

* You would first need to specify ExpressionAttributeValues as follows: *

*

* { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } *

*

* You could then use these values in an expression, such as this: *

*

* ProductStatus IN (:avail, :back, :disc) *

*

* For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public PutItemRequest withExpressionAttributeValues(java.util.Map expressionAttributeValues) { setExpressionAttributeValues(expressionAttributeValues); return this; } /** * Add a single ExpressionAttributeValues entry * * @see PutItemRequest#withExpressionAttributeValues * @returns a reference to this object so that method calls can be chained together. */ public PutItemRequest addExpressionAttributeValuesEntry(String key, AttributeValue value) { if (null == this.expressionAttributeValues) { this.expressionAttributeValues = new java.util.HashMap(); } if (this.expressionAttributeValues.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.expressionAttributeValues.put(key, value); return this; } /** * Removes all the entries added into ExpressionAttributeValues. * * @return Returns a reference to this object so that method calls can be chained together. */ public PutItemRequest clearExpressionAttributeValuesEntries() { this.expressionAttributeValues = null; return this; } /** *

* An optional parameter that returns the item attributes for a PutItem operation that failed a * condition check. *

*

* There is no additional cost associated with requesting a return value aside from the small network and processing * overhead of receiving a larger response. No read capacity units are consumed. *

* * @param returnValuesOnConditionCheckFailure * An optional parameter that returns the item attributes for a PutItem operation that failed a * condition check.

*

* There is no additional cost associated with requesting a return value aside from the small network and * processing overhead of receiving a larger response. No read capacity units are consumed. * @see ReturnValuesOnConditionCheckFailure */ public void setReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure) { this.returnValuesOnConditionCheckFailure = returnValuesOnConditionCheckFailure; } /** *

* An optional parameter that returns the item attributes for a PutItem operation that failed a * condition check. *

*

* There is no additional cost associated with requesting a return value aside from the small network and processing * overhead of receiving a larger response. No read capacity units are consumed. *

* * @return An optional parameter that returns the item attributes for a PutItem operation that failed a * condition check.

*

* There is no additional cost associated with requesting a return value aside from the small network and * processing overhead of receiving a larger response. No read capacity units are consumed. * @see ReturnValuesOnConditionCheckFailure */ public String getReturnValuesOnConditionCheckFailure() { return this.returnValuesOnConditionCheckFailure; } /** *

* An optional parameter that returns the item attributes for a PutItem operation that failed a * condition check. *

*

* There is no additional cost associated with requesting a return value aside from the small network and processing * overhead of receiving a larger response. No read capacity units are consumed. *

* * @param returnValuesOnConditionCheckFailure * An optional parameter that returns the item attributes for a PutItem operation that failed a * condition check.

*

* There is no additional cost associated with requesting a return value aside from the small network and * processing overhead of receiving a larger response. No read capacity units are consumed. * @return Returns a reference to this object so that method calls can be chained together. * @see ReturnValuesOnConditionCheckFailure */ public PutItemRequest withReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure) { setReturnValuesOnConditionCheckFailure(returnValuesOnConditionCheckFailure); return this; } /** *

* An optional parameter that returns the item attributes for a PutItem operation that failed a * condition check. *

*

* There is no additional cost associated with requesting a return value aside from the small network and processing * overhead of receiving a larger response. No read capacity units are consumed. *

* * @param returnValuesOnConditionCheckFailure * An optional parameter that returns the item attributes for a PutItem operation that failed a * condition check.

*

* There is no additional cost associated with requesting a return value aside from the small network and * processing overhead of receiving a larger response. No read capacity units are consumed. * @see ReturnValuesOnConditionCheckFailure */ public void setReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure) { withReturnValuesOnConditionCheckFailure(returnValuesOnConditionCheckFailure); } /** *

* An optional parameter that returns the item attributes for a PutItem operation that failed a * condition check. *

*

* There is no additional cost associated with requesting a return value aside from the small network and processing * overhead of receiving a larger response. No read capacity units are consumed. *

* * @param returnValuesOnConditionCheckFailure * An optional parameter that returns the item attributes for a PutItem operation that failed a * condition check.

*

* There is no additional cost associated with requesting a return value aside from the small network and * processing overhead of receiving a larger response. No read capacity units are consumed. * @return Returns a reference to this object so that method calls can be chained together. * @see ReturnValuesOnConditionCheckFailure */ public PutItemRequest withReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure) { this.returnValuesOnConditionCheckFailure = returnValuesOnConditionCheckFailure.toString(); return this; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getTableName() != null) sb.append("TableName: ").append(getTableName()).append(","); if (getItem() != null) sb.append("Item: ").append(getItem()).append(","); if (getExpected() != null) sb.append("Expected: ").append(getExpected()).append(","); if (getReturnValues() != null) sb.append("ReturnValues: ").append(getReturnValues()).append(","); if (getReturnConsumedCapacity() != null) sb.append("ReturnConsumedCapacity: ").append(getReturnConsumedCapacity()).append(","); if (getReturnItemCollectionMetrics() != null) sb.append("ReturnItemCollectionMetrics: ").append(getReturnItemCollectionMetrics()).append(","); if (getConditionalOperator() != null) sb.append("ConditionalOperator: ").append(getConditionalOperator()).append(","); if (getConditionExpression() != null) sb.append("ConditionExpression: ").append(getConditionExpression()).append(","); if (getExpressionAttributeNames() != null) sb.append("ExpressionAttributeNames: ").append(getExpressionAttributeNames()).append(","); if (getExpressionAttributeValues() != null) sb.append("ExpressionAttributeValues: ").append(getExpressionAttributeValues()).append(","); if (getReturnValuesOnConditionCheckFailure() != null) sb.append("ReturnValuesOnConditionCheckFailure: ").append(getReturnValuesOnConditionCheckFailure()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof PutItemRequest == false) return false; PutItemRequest other = (PutItemRequest) obj; if (other.getTableName() == null ^ this.getTableName() == null) return false; if (other.getTableName() != null && other.getTableName().equals(this.getTableName()) == false) return false; if (other.getItem() == null ^ this.getItem() == null) return false; if (other.getItem() != null && other.getItem().equals(this.getItem()) == false) return false; if (other.getExpected() == null ^ this.getExpected() == null) return false; if (other.getExpected() != null && other.getExpected().equals(this.getExpected()) == false) return false; if (other.getReturnValues() == null ^ this.getReturnValues() == null) return false; if (other.getReturnValues() != null && other.getReturnValues().equals(this.getReturnValues()) == false) return false; if (other.getReturnConsumedCapacity() == null ^ this.getReturnConsumedCapacity() == null) return false; if (other.getReturnConsumedCapacity() != null && other.getReturnConsumedCapacity().equals(this.getReturnConsumedCapacity()) == false) return false; if (other.getReturnItemCollectionMetrics() == null ^ this.getReturnItemCollectionMetrics() == null) return false; if (other.getReturnItemCollectionMetrics() != null && other.getReturnItemCollectionMetrics().equals(this.getReturnItemCollectionMetrics()) == false) return false; if (other.getConditionalOperator() == null ^ this.getConditionalOperator() == null) return false; if (other.getConditionalOperator() != null && other.getConditionalOperator().equals(this.getConditionalOperator()) == false) return false; if (other.getConditionExpression() == null ^ this.getConditionExpression() == null) return false; if (other.getConditionExpression() != null && other.getConditionExpression().equals(this.getConditionExpression()) == false) return false; if (other.getExpressionAttributeNames() == null ^ this.getExpressionAttributeNames() == null) return false; if (other.getExpressionAttributeNames() != null && other.getExpressionAttributeNames().equals(this.getExpressionAttributeNames()) == false) return false; if (other.getExpressionAttributeValues() == null ^ this.getExpressionAttributeValues() == null) return false; if (other.getExpressionAttributeValues() != null && other.getExpressionAttributeValues().equals(this.getExpressionAttributeValues()) == false) return false; if (other.getReturnValuesOnConditionCheckFailure() == null ^ this.getReturnValuesOnConditionCheckFailure() == null) return false; if (other.getReturnValuesOnConditionCheckFailure() != null && other.getReturnValuesOnConditionCheckFailure().equals(this.getReturnValuesOnConditionCheckFailure()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getTableName() == null) ? 0 : getTableName().hashCode()); hashCode = prime * hashCode + ((getItem() == null) ? 0 : getItem().hashCode()); hashCode = prime * hashCode + ((getExpected() == null) ? 0 : getExpected().hashCode()); hashCode = prime * hashCode + ((getReturnValues() == null) ? 0 : getReturnValues().hashCode()); hashCode = prime * hashCode + ((getReturnConsumedCapacity() == null) ? 0 : getReturnConsumedCapacity().hashCode()); hashCode = prime * hashCode + ((getReturnItemCollectionMetrics() == null) ? 0 : getReturnItemCollectionMetrics().hashCode()); hashCode = prime * hashCode + ((getConditionalOperator() == null) ? 0 : getConditionalOperator().hashCode()); hashCode = prime * hashCode + ((getConditionExpression() == null) ? 0 : getConditionExpression().hashCode()); hashCode = prime * hashCode + ((getExpressionAttributeNames() == null) ? 0 : getExpressionAttributeNames().hashCode()); hashCode = prime * hashCode + ((getExpressionAttributeValues() == null) ? 0 : getExpressionAttributeValues().hashCode()); hashCode = prime * hashCode + ((getReturnValuesOnConditionCheckFailure() == null) ? 0 : getReturnValuesOnConditionCheckFailure().hashCode()); return hashCode; } @Override public PutItemRequest clone() { return (PutItemRequest) super.clone(); } }