Class TableKeysAndAttributes
- java.lang.Object
-
- com.amazonaws.services.dynamodbv2.document.TableKeysAndAttributes
-
public class TableKeysAndAttributes extends Object
Used to specify one or multiple primary keys of a specific table, the attributes to be retrieved from that table, and the consistency of the read operation in aBatchGetItem
request.
-
-
Constructor Summary
Constructors Constructor Description TableKeysAndAttributes(String tableName)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description TableKeysAndAttributes
addHashAndRangePrimaryKey(String hashKeyName, Object hashKeyValue, String rangeKeyName, Object rangeKeyValue)
Adds a primary key (that consists of a hash-key and a range-key) to be included in the batch get-item operation.TableKeysAndAttributes
addHashAndRangePrimaryKeys(String hashKeyName, String rangeKeyName, Object... alternatingHashRangeKeyValues)
Adds multiple hash-and-range primary keys to be included in the batch get-item operation.TableKeysAndAttributes
addHashOnlyPrimaryKey(String hashKeyName, Object hashKeyValue)
Adds a hash-only primary key to be included in the batch get-item operation.TableKeysAndAttributes
addHashOnlyPrimaryKeys(String hashKeyName, Object... hashKeyValues)
Adds multiple hash-only primary keys to be included in the batch get-item operation.TableKeysAndAttributes
addPrimaryKey(PrimaryKey primaryKey)
Adds a primary key to be included in the batch get-item operation.Set<String>
getAttributeNames()
Map<String,String>
getNameMap()
List<PrimaryKey>
getPrimaryKeys()
Return the list of primary keys (of the current table) to be included in a batch get-item operation.String
getProjectionExpression()
String
getTableName()
boolean
isConsistentRead()
TableKeysAndAttributes
withAttrbuteNames(String... attributeNames)
Deprecated.TableKeysAndAttributes
withAttrbuteNames(List<String> attributeNames)
Deprecated.TableKeysAndAttributes
withAttributeNames(String... attributeNames)
Used to specify the attributes to be retrieved in each item returned from the batch get-item operation.TableKeysAndAttributes
withAttributeNames(List<String> attributeNames)
TableKeysAndAttributes
withConsistentRead(boolean consistentRead)
TableKeysAndAttributes
withHashAndRangeKeys(String hashKeyName, String rangeKeyName, Object... alternatingHashAndRangeKeyValues)
Used to specify multiple hash-and-range primary keys.TableKeysAndAttributes
withHashOnlyKeys(String hashKeyName, Object... hashKeyValues)
Used to specify multiple hash-only primary keys.TableKeysAndAttributes
withNameMap(Map<String,String> nameMap)
TableKeysAndAttributes
withPrimaryKeys(PrimaryKey... primaryKeys)
Used to specify multiple primary keys.TableKeysAndAttributes
withProjectionExpression(String projectionExpression)
-
-
-
Constructor Detail
-
TableKeysAndAttributes
public TableKeysAndAttributes(String tableName)
-
-
Method Detail
-
getPrimaryKeys
public List<PrimaryKey> getPrimaryKeys()
Return the list of primary keys (of the current table) to be included in a batch get-item operation.
-
withPrimaryKeys
public TableKeysAndAttributes withPrimaryKeys(PrimaryKey... primaryKeys)
Used to specify multiple primary keys. 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.
-
withHashOnlyKeys
public TableKeysAndAttributes withHashOnlyKeys(String hashKeyName, Object... hashKeyValues)
Used to specify multiple hash-only primary keys.- Parameters:
hashKeyName
- hash-only key namehashKeyValues
- a list of hash key values
-
withHashAndRangeKeys
public TableKeysAndAttributes withHashAndRangeKeys(String hashKeyName, String rangeKeyName, Object... alternatingHashAndRangeKeyValues)
Used to specify multiple hash-and-range primary keys.- Parameters:
hashKeyName
- hash key namerangeKeyName
- range key namealternatingHashAndRangeKeyValues
- a list of alternating hash key value and range key value
-
addPrimaryKey
public TableKeysAndAttributes addPrimaryKey(PrimaryKey primaryKey)
Adds a primary key to be included in the batch get-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.
-
addHashOnlyPrimaryKey
public TableKeysAndAttributes addHashOnlyPrimaryKey(String hashKeyName, Object hashKeyValue)
Adds a hash-only primary key to be included in the batch get-item operation.- Parameters:
hashKeyName
- name of the hash key attribute namehashKeyValue
- name of the hash key value- Returns:
- the current instance for method chaining purposes
-
addHashOnlyPrimaryKeys
public TableKeysAndAttributes addHashOnlyPrimaryKeys(String hashKeyName, Object... hashKeyValues)
Adds multiple hash-only primary keys to be included in the batch get-item operation.- Parameters:
hashKeyName
- name of the hash key attribute namehashKeyValues
- multiple hash key values- Returns:
- the current instance for method chaining purposes
-
addHashAndRangePrimaryKeys
public TableKeysAndAttributes addHashAndRangePrimaryKeys(String hashKeyName, String rangeKeyName, Object... alternatingHashRangeKeyValues)
Adds multiple hash-and-range primary keys to be included in the batch get-item 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
-
addHashAndRangePrimaryKey
public TableKeysAndAttributes addHashAndRangePrimaryKey(String hashKeyName, Object hashKeyValue, String rangeKeyName, Object rangeKeyValue)
Adds a primary key (that consists of a hash-key and a range-key) to be included in the batch get-item 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
-
withAttrbuteNames
@Deprecated public TableKeysAndAttributes withAttrbuteNames(String... attributeNames)
Deprecated.
-
withAttrbuteNames
@Deprecated public TableKeysAndAttributes withAttrbuteNames(List<String> attributeNames)
Deprecated.
-
withAttributeNames
public TableKeysAndAttributes withAttributeNames(String... attributeNames)
Used to specify the attributes to be retrieved in each item returned from the batch get-item operation.- Parameters:
attributeNames
- names of the attributes to be retrieved in each item returned from the batch get-item operation.- Returns:
- the current instance for method chaining purposes
-
withAttributeNames
public TableKeysAndAttributes withAttributeNames(List<String> attributeNames)
-
getTableName
public String getTableName()
-
isConsistentRead
public boolean isConsistentRead()
-
withConsistentRead
public TableKeysAndAttributes withConsistentRead(boolean consistentRead)
-
getProjectionExpression
public String getProjectionExpression()
-
withProjectionExpression
public TableKeysAndAttributes withProjectionExpression(String projectionExpression)
-
withNameMap
public TableKeysAndAttributes withNameMap(Map<String,String> nameMap)
-
-