KeysAndAttributes (AWS Java SDK for Amazon DynamoDB 1.9.14 API)

java.lang.Object
- com.amazonaws.services.dynamodbv2.model.KeysAndAttributes

All Implemented Interfaces:

Serializable
```
public class KeysAndAttributes
extends Object
implements Serializable
```
Represents a set of primary keys and, for each key, the attributes to retrieve from the table.

For each primary key, you must provide all of the key attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

KeysAndAttributes()

Constructors
Constructor and Description
`KeysAndAttributes()`

Method Summary

Methods
Modifier and Type	Method and Description
`KeysAndAttributes`	`addExpressionAttributeNamesEntry(String key, String value)` One or more substitution tokens for simplifying complex expressions.
`KeysAndAttributes`	`clearExpressionAttributeNamesEntries()` Removes all the entries added into ExpressionAttributeNames.
`boolean`	`equals(Object obj)`
`List<String>`	`getAttributesToGet()` One or more attributes to retrieve from the table or index.
`Boolean`	`getConsistentRead()` The consistency of a read operation.
`Map<String,String>`	`getExpressionAttributeNames()` One or more substitution tokens for simplifying complex expressions.
`List<Map<String,AttributeValue>>`	`getKeys()` The primary key attribute values that define the items and the attributes associated with the items.
`String`	`getProjectionExpression()` One or more attributes to retrieve from the table.
`int`	`hashCode()`
`Boolean`	`isConsistentRead()` The consistency of a read operation.
`void`	`setAttributesToGet(Collection<String> attributesToGet)` One or more attributes to retrieve from the table or index.
`void`	`setConsistentRead(Boolean consistentRead)` The consistency of a read operation.
`void`	`setExpressionAttributeNames(Map<String,String> expressionAttributeNames)` One or more substitution tokens for simplifying complex expressions.
`void`	`setKeys(Collection<Map<String,AttributeValue>> keys)` The primary key attribute values that define the items and the attributes associated with the items.
`void`	`setProjectionExpression(String projectionExpression)` One or more attributes to retrieve from the table.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`KeysAndAttributes`	`withAttributesToGet(Collection<String> attributesToGet)` One or more attributes to retrieve from the table or index.
`KeysAndAttributes`	`withAttributesToGet(String... attributesToGet)` One or more attributes to retrieve from the table or index.
`KeysAndAttributes`	`withConsistentRead(Boolean consistentRead)` The consistency of a read operation.
`KeysAndAttributes`	`withExpressionAttributeNames(Map<String,String> expressionAttributeNames)` One or more substitution tokens for simplifying complex expressions.
`KeysAndAttributes`	`withKeys(Collection<Map<String,AttributeValue>> keys)` The primary key attribute values that define the items and the attributes associated with the items.
`KeysAndAttributes`	`withKeys(Map<String,AttributeValue>... keys)` The primary key attribute values that define the items and the attributes associated with the items.
`KeysAndAttributes`	`withProjectionExpression(String projectionExpression)` One or more attributes to retrieve from the table.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - KeysAndAttributes
```
public KeysAndAttributes()
```
- Method Detail
  - getKeys
```
public List<Map<String,AttributeValue>> getKeys()
```
    The primary key attribute values that define the items and the attributes associated with the items.
    Constraints:
    Length: 1 - 100
    
    Returns:
    The primary key attribute values that define the items and the attributes associated with the items.
  - setKeys
```
public void setKeys(Collection<Map<String,AttributeValue>> keys)
```
    The primary key attribute values that define the items and the attributes associated with the items.
    Constraints:
    Length: 1 - 100
    
    Parameters:
    keys - The primary key attribute values that define the items and the attributes associated with the items.
  - withKeys
```
public KeysAndAttributes withKeys(Map<String,AttributeValue>... keys)
```
    The primary key attribute values that define the items and the attributes associated with the items.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 100
    
    Parameters:
    keys - The primary key attribute values that define the items and the attributes associated with the items.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withKeys
```
public KeysAndAttributes withKeys(Collection<Map<String,AttributeValue>> keys)
```
    The primary key attribute values that define the items and the attributes associated with the items.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 100
    
    Parameters:
    keys - The primary key attribute values that define the items and the attributes associated with the items.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getAttributesToGet
```
public List<String> getAttributesToGet()
```
    One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.
    Constraints:
    Length: 1 -
    
    Returns:
    One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.
  - setAttributesToGet
```
public void setAttributesToGet(Collection<String> attributesToGet)
```
    One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.
    Constraints:
    Length: 1 -
    
    Parameters:
    attributesToGet - One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.
  - withAttributesToGet
```
public KeysAndAttributes withAttributesToGet(String... attributesToGet)
```
    One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 -
    
    Parameters:
    attributesToGet - One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withAttributesToGet
```
public KeysAndAttributes withAttributesToGet(Collection<String> attributesToGet)
```
    One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 -
    
    Parameters:
    attributesToGet - One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - isConsistentRead
```
public Boolean isConsistentRead()
```
    The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.
    
    Returns:
    The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.
  - setConsistentRead
```
public void setConsistentRead(Boolean consistentRead)
```
    The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.
    
    Parameters:
    consistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.
  - withConsistentRead
```
public KeysAndAttributes withConsistentRead(Boolean consistentRead)
```
    The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    consistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getConsistentRead
```
public Boolean getConsistentRead()
```
    The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.
    
    Returns:
    The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.
  - getProjectionExpression
```
public String getProjectionExpression()
```
    One or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
    If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
    
    Returns:
    One or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
    If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
  - setProjectionExpression
```
public void setProjectionExpression(String projectionExpression)
```
    One or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
    If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
    
    Parameters:
    projectionExpression - One or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
    If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
  - withProjectionExpression
```
public KeysAndAttributes withProjectionExpression(String projectionExpression)
```
    One or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
    If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    projectionExpression - One or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
    If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getExpressionAttributeNames
```
public Map<String,String> getExpressionAttributeNames()
```
    One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:
    - To shorten an attribute name that is very long or unwieldy in an expression.
    - 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 expression:
    - order.customerInfo.LastName = "Smith" OR order.customerInfo.LastName = "Jones"
    Now suppose that you specified the following for ExpressionAttributeNames:
    - {"n":"order.customerInfo.LastName"}
    The expression can now be simplified as follows:
    - #n = "Smith" OR #n = "Jones"
    Returns:
    One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:
    
    To shorten an attribute name that is very long or unwieldy in an expression.
    
    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 expression:
    order.customerInfo.LastName = "Smith" OR order.customerInfo.LastName = "Jones"
    
    Now suppose that you specified the following for ExpressionAttributeNames:
    {"n":"order.customerInfo.LastName"}
    
    The expression can now be simplified as follows:
    #n = "Smith" OR #n = "Jones"
  - setExpressionAttributeNames
```
public void setExpressionAttributeNames(Map<String,String> expressionAttributeNames)
```
    One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:
    - To shorten an attribute name that is very long or unwieldy in an expression.
    - 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 expression:
    - order.customerInfo.LastName = "Smith" OR order.customerInfo.LastName = "Jones"
    Now suppose that you specified the following for ExpressionAttributeNames:
    - {"n":"order.customerInfo.LastName"}
    The expression can now be simplified as follows:
    - #n = "Smith" OR #n = "Jones"
    Parameters:
    expressionAttributeNames - One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:
    
    To shorten an attribute name that is very long or unwieldy in an expression.
    
    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 expression:
    order.customerInfo.LastName = "Smith" OR order.customerInfo.LastName = "Jones"
    
    Now suppose that you specified the following for ExpressionAttributeNames:
    {"n":"order.customerInfo.LastName"}
    
    The expression can now be simplified as follows:
    #n = "Smith" OR #n = "Jones"
  - withExpressionAttributeNames
```
public KeysAndAttributes withExpressionAttributeNames(Map<String,String> expressionAttributeNames)
```
    One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:
    - To shorten an attribute name that is very long or unwieldy in an expression.
    - 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 expression:
    - order.customerInfo.LastName = "Smith" OR order.customerInfo.LastName = "Jones"
    Now suppose that you specified the following for ExpressionAttributeNames:
    - {"n":"order.customerInfo.LastName"}
    The expression can now be simplified as follows:
    - #n = "Smith" OR #n = "Jones"
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    expressionAttributeNames - One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:
    
    To shorten an attribute name that is very long or unwieldy in an expression.
    
    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 expression:
    order.customerInfo.LastName = "Smith" OR order.customerInfo.LastName = "Jones"
    
    Now suppose that you specified the following for ExpressionAttributeNames:
    {"n":"order.customerInfo.LastName"}
    
    The expression can now be simplified as follows:
    #n = "Smith" OR #n = "Jones"
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - addExpressionAttributeNamesEntry
```
public KeysAndAttributes addExpressionAttributeNamesEntry(String key,
                                                 String value)
```
    One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:
    - To shorten an attribute name that is very long or unwieldy in an expression.
    - 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 expression:
    - order.customerInfo.LastName = "Smith" OR order.customerInfo.LastName = "Jones"
    Now suppose that you specified the following for ExpressionAttributeNames:
    - {"n":"order.customerInfo.LastName"}
    The expression can now be simplified as follows:
    - #n = "Smith" OR #n = "Jones"
    The method adds a new key-value pair into ExpressionAttributeNames parameter, and returns a reference to this object so that method calls can be chained together.
    Parameters:
    key - The key of the entry to be added into ExpressionAttributeNames.
    value - The corresponding value of the entry to be added into ExpressionAttributeNames.
  - clearExpressionAttributeNamesEntries
```
public KeysAndAttributes clearExpressionAttributeNamesEntries()
```
    Removes all the entries added into ExpressionAttributeNames.
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class KeysAndAttributes

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KeysAndAttributes

Method Detail

getKeys

setKeys

withKeys

withKeys

getAttributesToGet

setAttributesToGet

withAttributesToGet

withAttributesToGet

isConsistentRead

setConsistentRead

withConsistentRead

getConsistentRead

getProjectionExpression

setProjectionExpression

withProjectionExpression

getExpressionAttributeNames

setExpressionAttributeNames

withExpressionAttributeNames

addExpressionAttributeNamesEntry

clearExpressionAttributeNamesEntries

toString

hashCode

equals