Class AttributeValueUpdate
- java.lang.Object
-
- com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class AttributeValueUpdate extends Object implements Serializable, Cloneable
For the UpdateItem operation, represents the attributes to be modified, the action to perform on each, and the new value for each.
You cannot use UpdateItem to update any primary key attributes. Instead, you will need to delete the item, and then use PutItem to create a new item with new attributes.
Attribute values cannot be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description AttributeValueUpdate()
Default constructor for AttributeValueUpdate object.AttributeValueUpdate(AttributeValue value, AttributeAction action)
Constructs a new AttributeValueUpdate object.AttributeValueUpdate(AttributeValue value, String action)
Constructs a new AttributeValueUpdate object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AttributeValueUpdate
clone()
boolean
equals(Object obj)
String
getAction()
Specifies how to perform the update.AttributeValue
getValue()
int
hashCode()
void
setAction(AttributeAction action)
Specifies how to perform the update.void
setAction(String action)
Specifies how to perform the update.void
setValue(AttributeValue value)
String
toString()
Returns a string representation of this object; useful for testing and debugging.AttributeValueUpdate
withAction(AttributeAction action)
Specifies how to perform the update.AttributeValueUpdate
withAction(String action)
Specifies how to perform the update.AttributeValueUpdate
withValue(AttributeValue value)
-
-
-
Constructor Detail
-
AttributeValueUpdate
public AttributeValueUpdate()
Default constructor for AttributeValueUpdate object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
-
AttributeValueUpdate
public AttributeValueUpdate(AttributeValue value, String action)
Constructs a new AttributeValueUpdate object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
value
-action
- Specifies how to perform the update. Valid values arePUT
(default),DELETE
, andADD
. The behavior depends on whether the specified primary key already exists in the table.If an item with the specified Key is found in the table:
-
PUT
- Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. -
DELETE
- If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set
[a,b,c]
and the DELETE action specified[a,c]
, then the final attribute value would be[b]
. Specifying an empty set is an error. -
ADD
- If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior ofADD
depends on the data type of the attribute:-
If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use
ADD
to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.In addition, if you use
ADD
to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute in the item, with a value of3
. -
If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set
[1,2]
, and theADD
action specified[3]
, then the final attribute value would be[1,2,3]
. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid for an existing attribute whose data type is number or is a set. Do not use
ADD
for any other data types. -
If no item with the specified Key is found:
-
PUT
- DynamoDB creates a new item with the specified primary key, and then adds the attribute. -
DELETE
- Nothing happens; there is no attribute to delete. -
ADD
- DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.
-
-
AttributeValueUpdate
public AttributeValueUpdate(AttributeValue value, AttributeAction action)
Constructs a new AttributeValueUpdate object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
value
-action
- Specifies how to perform the update. Valid values arePUT
(default),DELETE
, andADD
. The behavior depends on whether the specified primary key already exists in the table.If an item with the specified Key is found in the table:
-
PUT
- Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. -
DELETE
- If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set
[a,b,c]
and the DELETE action specified[a,c]
, then the final attribute value would be[b]
. Specifying an empty set is an error. -
ADD
- If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior ofADD
depends on the data type of the attribute:-
If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use
ADD
to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.In addition, if you use
ADD
to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute in the item, with a value of3
. -
If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set
[1,2]
, and theADD
action specified[3]
, then the final attribute value would be[1,2,3]
. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid for an existing attribute whose data type is number or is a set. Do not use
ADD
for any other data types. -
If no item with the specified Key is found:
-
PUT
- DynamoDB creates a new item with the specified primary key, and then adds the attribute. -
DELETE
- Nothing happens; there is no attribute to delete. -
ADD
- DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.
-
-
-
Method Detail
-
setValue
public void setValue(AttributeValue value)
- Parameters:
value
-
-
getValue
public AttributeValue getValue()
- Returns:
-
withValue
public AttributeValueUpdate withValue(AttributeValue value)
- Parameters:
value
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAction
public void setAction(String action)
Specifies how to perform the update. Valid values are
PUT
(default),DELETE
, andADD
. The behavior depends on whether the specified primary key already exists in the table.If an item with the specified Key is found in the table:
-
PUT
- Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. -
DELETE
- If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set
[a,b,c]
and the DELETE action specified[a,c]
, then the final attribute value would be[b]
. Specifying an empty set is an error. -
ADD
- If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior ofADD
depends on the data type of the attribute:-
If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use
ADD
to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.In addition, if you use
ADD
to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute in the item, with a value of3
. -
If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set
[1,2]
, and theADD
action specified[3]
, then the final attribute value would be[1,2,3]
. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid for an existing attribute whose data type is number or is a set. Do not use
ADD
for any other data types. -
If no item with the specified Key is found:
-
PUT
- DynamoDB creates a new item with the specified primary key, and then adds the attribute. -
DELETE
- Nothing happens; there is no attribute to delete. -
ADD
- DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.
- Parameters:
action
- Specifies how to perform the update. Valid values arePUT
(default),DELETE
, andADD
. The behavior depends on whether the specified primary key already exists in the table.If an item with the specified Key is found in the table:
-
PUT
- Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. -
DELETE
- If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set
[a,b,c]
and the DELETE action specified[a,c]
, then the final attribute value would be[b]
. Specifying an empty set is an error. -
ADD
- If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior ofADD
depends on the data type of the attribute:-
If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use
ADD
to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.In addition, if you use
ADD
to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute in the item, with a value of3
. -
If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set
[1,2]
, and theADD
action specified[3]
, then the final attribute value would be[1,2,3]
. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid for an existing attribute whose data type is number or is a set. Do not use
ADD
for any other data types. -
If no item with the specified Key is found:
-
PUT
- DynamoDB creates a new item with the specified primary key, and then adds the attribute. -
DELETE
- Nothing happens; there is no attribute to delete. -
ADD
- DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.
-
- See Also:
AttributeAction
-
-
getAction
public String getAction()
Specifies how to perform the update. Valid values are
PUT
(default),DELETE
, andADD
. The behavior depends on whether the specified primary key already exists in the table.If an item with the specified Key is found in the table:
-
PUT
- Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. -
DELETE
- If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set
[a,b,c]
and the DELETE action specified[a,c]
, then the final attribute value would be[b]
. Specifying an empty set is an error. -
ADD
- If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior ofADD
depends on the data type of the attribute:-
If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use
ADD
to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.In addition, if you use
ADD
to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute in the item, with a value of3
. -
If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set
[1,2]
, and theADD
action specified[3]
, then the final attribute value would be[1,2,3]
. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid for an existing attribute whose data type is number or is a set. Do not use
ADD
for any other data types. -
If no item with the specified Key is found:
-
PUT
- DynamoDB creates a new item with the specified primary key, and then adds the attribute. -
DELETE
- Nothing happens; there is no attribute to delete. -
ADD
- DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.
- Returns:
- Specifies how to perform the update. Valid values are
PUT
(default),DELETE
, andADD
. The behavior depends on whether the specified primary key already exists in the table.If an item with the specified Key is found in the table:
-
PUT
- Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. -
DELETE
- If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set
[a,b,c]
and the DELETE action specified[a,c]
, then the final attribute value would be[b]
. Specifying an empty set is an error. -
ADD
- If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior ofADD
depends on the data type of the attribute:-
If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use
ADD
to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.In addition, if you use
ADD
to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute in the item, with a value of3
. -
If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set
[1,2]
, and theADD
action specified[3]
, then the final attribute value would be[1,2,3]
. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid for an existing attribute whose data type is number or is a set. Do not use
ADD
for any other data types. -
If no item with the specified Key is found:
-
PUT
- DynamoDB creates a new item with the specified primary key, and then adds the attribute. -
DELETE
- Nothing happens; there is no attribute to delete. -
ADD
- DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.
-
- See Also:
AttributeAction
-
-
withAction
public AttributeValueUpdate withAction(String action)
Specifies how to perform the update. Valid values are
PUT
(default),DELETE
, andADD
. The behavior depends on whether the specified primary key already exists in the table.If an item with the specified Key is found in the table:
-
PUT
- Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. -
DELETE
- If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set
[a,b,c]
and the DELETE action specified[a,c]
, then the final attribute value would be[b]
. Specifying an empty set is an error. -
ADD
- If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior ofADD
depends on the data type of the attribute:-
If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use
ADD
to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.In addition, if you use
ADD
to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute in the item, with a value of3
. -
If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set
[1,2]
, and theADD
action specified[3]
, then the final attribute value would be[1,2,3]
. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid for an existing attribute whose data type is number or is a set. Do not use
ADD
for any other data types. -
If no item with the specified Key is found:
-
PUT
- DynamoDB creates a new item with the specified primary key, and then adds the attribute. -
DELETE
- Nothing happens; there is no attribute to delete. -
ADD
- DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.
- Parameters:
action
- Specifies how to perform the update. Valid values arePUT
(default),DELETE
, andADD
. The behavior depends on whether the specified primary key already exists in the table.If an item with the specified Key is found in the table:
-
PUT
- Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. -
DELETE
- If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set
[a,b,c]
and the DELETE action specified[a,c]
, then the final attribute value would be[b]
. Specifying an empty set is an error. -
ADD
- If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior ofADD
depends on the data type of the attribute:-
If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use
ADD
to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.In addition, if you use
ADD
to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute in the item, with a value of3
. -
If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set
[1,2]
, and theADD
action specified[3]
, then the final attribute value would be[1,2,3]
. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid for an existing attribute whose data type is number or is a set. Do not use
ADD
for any other data types. -
If no item with the specified Key is found:
-
PUT
- DynamoDB creates a new item with the specified primary key, and then adds the attribute. -
DELETE
- Nothing happens; there is no attribute to delete. -
ADD
- DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AttributeAction
-
-
setAction
public void setAction(AttributeAction action)
Specifies how to perform the update. Valid values are
PUT
(default),DELETE
, andADD
. The behavior depends on whether the specified primary key already exists in the table.If an item with the specified Key is found in the table:
-
PUT
- Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. -
DELETE
- If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set
[a,b,c]
and the DELETE action specified[a,c]
, then the final attribute value would be[b]
. Specifying an empty set is an error. -
ADD
- If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior ofADD
depends on the data type of the attribute:-
If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use
ADD
to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.In addition, if you use
ADD
to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute in the item, with a value of3
. -
If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set
[1,2]
, and theADD
action specified[3]
, then the final attribute value would be[1,2,3]
. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid for an existing attribute whose data type is number or is a set. Do not use
ADD
for any other data types. -
If no item with the specified Key is found:
-
PUT
- DynamoDB creates a new item with the specified primary key, and then adds the attribute. -
DELETE
- Nothing happens; there is no attribute to delete. -
ADD
- DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.
- Parameters:
action
- Specifies how to perform the update. Valid values arePUT
(default),DELETE
, andADD
. The behavior depends on whether the specified primary key already exists in the table.If an item with the specified Key is found in the table:
-
PUT
- Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. -
DELETE
- If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set
[a,b,c]
and the DELETE action specified[a,c]
, then the final attribute value would be[b]
. Specifying an empty set is an error. -
ADD
- If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior ofADD
depends on the data type of the attribute:-
If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use
ADD
to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.In addition, if you use
ADD
to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute in the item, with a value of3
. -
If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set
[1,2]
, and theADD
action specified[3]
, then the final attribute value would be[1,2,3]
. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid for an existing attribute whose data type is number or is a set. Do not use
ADD
for any other data types. -
If no item with the specified Key is found:
-
PUT
- DynamoDB creates a new item with the specified primary key, and then adds the attribute. -
DELETE
- Nothing happens; there is no attribute to delete. -
ADD
- DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.
-
- See Also:
AttributeAction
-
-
withAction
public AttributeValueUpdate withAction(AttributeAction action)
Specifies how to perform the update. Valid values are
PUT
(default),DELETE
, andADD
. The behavior depends on whether the specified primary key already exists in the table.If an item with the specified Key is found in the table:
-
PUT
- Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. -
DELETE
- If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set
[a,b,c]
and the DELETE action specified[a,c]
, then the final attribute value would be[b]
. Specifying an empty set is an error. -
ADD
- If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior ofADD
depends on the data type of the attribute:-
If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use
ADD
to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.In addition, if you use
ADD
to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute in the item, with a value of3
. -
If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set
[1,2]
, and theADD
action specified[3]
, then the final attribute value would be[1,2,3]
. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid for an existing attribute whose data type is number or is a set. Do not use
ADD
for any other data types. -
If no item with the specified Key is found:
-
PUT
- DynamoDB creates a new item with the specified primary key, and then adds the attribute. -
DELETE
- Nothing happens; there is no attribute to delete. -
ADD
- DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.
- Parameters:
action
- Specifies how to perform the update. Valid values arePUT
(default),DELETE
, andADD
. The behavior depends on whether the specified primary key already exists in the table.If an item with the specified Key is found in the table:
-
PUT
- Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. -
DELETE
- If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set
[a,b,c]
and the DELETE action specified[a,c]
, then the final attribute value would be[b]
. Specifying an empty set is an error. -
ADD
- If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior ofADD
depends on the data type of the attribute:-
If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If you use
ADD
to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.In addition, if you use
ADD
to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute in the item, with a value of3
. -
If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set
[1,2]
, and theADD
action specified[3]
, then the final attribute value would be[1,2,3]
. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid for an existing attribute whose data type is number or is a set. Do not use
ADD
for any other data types. -
If no item with the specified Key is found:
-
PUT
- DynamoDB creates a new item with the specified primary key, and then adds the attribute. -
DELETE
- Nothing happens; there is no attribute to delete. -
ADD
- DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AttributeAction
-
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public AttributeValueUpdate clone()
-
-