Class TableWriteItems
java.lang.Object
com.amazonaws.services.dynamodbv2.document.TableWriteItems
Used to specify items to be put and/or primary keys to be deleted from a
specific table in a
BatchWriteItem
request.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddHashAndRangePrimaryKeysToDelete
(String hashKeyName, String rangeKeyName, Object... alternatingHashRangeKeyValues) Adds multiple hash-and-range primary keys to be deleted in a batch write operation.addHashAndRangePrimaryKeyToDelete
(String hashKeyName, Object hashKeyValue, String rangeKeyName, Object rangeKeyValue) Adds a primary key (that consists of a hash-key and a range-key) to be deleted in a batch write operation.addHashOnlyPrimaryKeysToDelete
(String hashKeyName, Object... hashKeyValues) Adds multiple hash-only primary keys to be deleted in a batch write operation.addHashOnlyPrimaryKeyToDelete
(String hashKeyName, Object hashKeyValue) Adds a hash-only primary key to be deleted in a batch write operation.addItemToPut
(Item item) Adds an item to be put to the current table in a batch write operation.addPrimaryKeyToDelete
(PrimaryKey primaryKey) Adds a primary key to be deleted in a batch write-item operation.Returns the collection of items to be put in the current table in a batch write operation.Return the list of primary keys (of the current table) to be deleted in a batch write operation.withHashAndRangeKeysToDelete
(String hashKeyName, String rangeKeyName, Object... alternatingHashAndRangeKeyValues) Used to specify multiple hash-and-range primary keys to be deleted from the current table.withHashOnlyKeysToDelete
(String hashKeyName, Object... hashKeyValues) Used to specify multiple hash-only primary keys to be deleted from the current table.withItemsToPut
(Item... itemsToPut) Used to specify the items to be put in the current table in a batch write operation.withItemsToPut
(Collection<Item> itemsToPut) Used to specify the collection of items to be put in the current table in a batch write operation.withPrimaryKeysToDelete
(PrimaryKey... primaryKeysToDelete) Used to specify multiple primary keys to be deleted from the current table.
-
Constructor Details
-
TableWriteItems
-
-
Method Details
-
getPrimaryKeysToDelete
Return the list of primary keys (of the current table) to be deleted in a batch write operation. -
withPrimaryKeysToDelete
Used to specify multiple primary keys to be deleted from the current table. A primary key could consist of either a hash-key or both a hash-key and a range-key depending on the schema of the table. -
withHashOnlyKeysToDelete
Used to specify multiple hash-only primary keys to be deleted from the current table.- Parameters:
hashKeyName
- hash-only key namehashKeyValues
- a list of hash key values
-
withHashAndRangeKeysToDelete
public TableWriteItems withHashAndRangeKeysToDelete(String hashKeyName, String rangeKeyName, Object... alternatingHashAndRangeKeyValues) Used to specify multiple hash-and-range primary keys to be deleted from the current table.- Parameters:
hashKeyName
- hash key namerangeKeyName
- range key namealternatingHashAndRangeKeyValues
- a list of alternating hash key value and range key value
-
addPrimaryKeyToDelete
Adds a primary key to be deleted in a batch write-item operation. A primary key could consist of either a hash-key or both a hash-key and a range-key depending on the schema of the table. -
addHashOnlyPrimaryKeyToDelete
Adds a hash-only primary key to be deleted in a batch write operation.- Parameters:
hashKeyName
- name of the hash key attribute namehashKeyValue
- name of the hash key value- Returns:
- the current instance for method chaining purposes
-
addHashOnlyPrimaryKeysToDelete
Adds multiple hash-only primary keys to be deleted in a batch write operation.- Parameters:
hashKeyName
- name of the hash key attribute namehashKeyValues
- multiple hash key values- Returns:
- the current instance for method chaining purposes
-
addHashAndRangePrimaryKeysToDelete
public TableWriteItems addHashAndRangePrimaryKeysToDelete(String hashKeyName, String rangeKeyName, Object... alternatingHashRangeKeyValues) Adds multiple hash-and-range primary keys to be deleted in a batch write operation.- Parameters:
hashKeyName
- name of the hash key attribute namerangeKeyName
- name of the range key attribute namealternatingHashRangeKeyValues
- used to specify multiple alternating hash key and range key values- Returns:
- the current instance for method chaining purposes
-
addHashAndRangePrimaryKeyToDelete
public TableWriteItems addHashAndRangePrimaryKeyToDelete(String hashKeyName, Object hashKeyValue, String rangeKeyName, Object rangeKeyValue) Adds a primary key (that consists of a hash-key and a range-key) to be deleted in a batch write operation.- Parameters:
hashKeyName
- hash key attribute namehashKeyValue
- hash key valuerangeKeyName
- range key attribute namerangeKeyValue
- range key value- Returns:
- the current instance for method chaining purposes
-
withItemsToPut
Used to specify the items to be put in the current table in a batch write operation.- Returns:
- the current instance for method chaining purposes
-
withItemsToPut
Used to specify the collection of items to be put in the current table in a batch write operation.- Returns:
- the current instance for method chaining purposes
-
getItemsToPut
Returns the collection of items to be put in the current table in a batch write operation. -
getTableName
-
addItemToPut
Adds an item to be put to the current table in a batch write operation.
-