@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class KeysAndAttributes extends Object implements Serializable, Cloneable, StructuredPojo
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 simple primary key, you only need to provide the partition key. For a composite primary key, you must provide both the partition key and the sort key.
Constructor and Description |
---|
KeysAndAttributes() |
Modifier and Type | Method and Description |
---|---|
KeysAndAttributes |
addExpressionAttributeNamesEntry(String key,
String value)
Add a single ExpressionAttributeNames entry
|
KeysAndAttributes |
clearExpressionAttributeNamesEntries()
Removes all the entries added into ExpressionAttributeNames.
|
KeysAndAttributes |
clone() |
boolean |
equals(Object obj) |
List<String> |
getAttributesToGet()
This is a legacy parameter.
|
Boolean |
getConsistentRead()
The consistency of a read operation.
|
Map<String,String> |
getExpressionAttributeNames()
One or more substitution tokens for attribute names in an expression.
|
List<Map<String,AttributeValue>> |
getKeys()
The primary key attribute values that define the items and the attributes associated with the items.
|
String |
getProjectionExpression()
A string that identifies one or more attributes to retrieve from the table.
|
int |
hashCode() |
Boolean |
isConsistentRead()
The consistency of a read operation.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAttributesToGet(Collection<String> attributesToGet)
This is a legacy parameter.
|
void |
setConsistentRead(Boolean consistentRead)
The consistency of a read operation.
|
void |
setExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.
|
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)
A string that identifies one or more attributes to retrieve from the table.
|
String |
toString()
Returns a string representation of this object.
|
KeysAndAttributes |
withAttributesToGet(Collection<String> attributesToGet)
This is a legacy parameter.
|
KeysAndAttributes |
withAttributesToGet(String... attributesToGet)
This is a legacy parameter.
|
KeysAndAttributes |
withConsistentRead(Boolean consistentRead)
The consistency of a read operation.
|
KeysAndAttributes |
withExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.
|
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)
A string that identifies one or more attributes to retrieve from the table.
|
public List<Map<String,AttributeValue>> getKeys()
The primary key attribute values that define the items and the attributes associated with the items.
public void setKeys(Collection<Map<String,AttributeValue>> keys)
The primary key attribute values that define the items and the attributes associated with the items.
keys
- The primary key attribute values that define the items and the attributes associated with the items.public KeysAndAttributes withKeys(Map<String,AttributeValue>... keys)
The primary key attribute values that define the items and the attributes associated with the items.
NOTE: This method appends the values to the existing list (if any). Use
setKeys(java.util.Collection)
or withKeys(java.util.Collection)
if you want to override the
existing values.
keys
- The primary key attribute values that define the items and the attributes associated with the items.public KeysAndAttributes withKeys(Collection<Map<String,AttributeValue>> keys)
The primary key attribute values that define the items and the attributes associated with the items.
keys
- The primary key attribute values that define the items and the attributes associated with the items.public List<String> getAttributesToGet()
This is a legacy parameter. Use ProjectionExpression
instead. For more information, see Legacy
Conditional Parameters in the Amazon DynamoDB Developer Guide.
ProjectionExpression
instead. For more information, see
Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.public void setAttributesToGet(Collection<String> attributesToGet)
This is a legacy parameter. Use ProjectionExpression
instead. For more information, see Legacy
Conditional Parameters in the Amazon DynamoDB Developer Guide.
attributesToGet
- This is a legacy parameter. Use ProjectionExpression
instead. For more information, see
Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.public KeysAndAttributes withAttributesToGet(String... attributesToGet)
This is a legacy parameter. Use ProjectionExpression
instead. For more information, see Legacy
Conditional Parameters in the Amazon DynamoDB Developer Guide.
NOTE: This method appends the values to the existing list (if any). Use
setAttributesToGet(java.util.Collection)
or withAttributesToGet(java.util.Collection)
if you
want to override the existing values.
attributesToGet
- This is a legacy parameter. Use ProjectionExpression
instead. For more information, see
Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.public KeysAndAttributes withAttributesToGet(Collection<String> attributesToGet)
This is a legacy parameter. Use ProjectionExpression
instead. For more information, see Legacy
Conditional Parameters in the Amazon DynamoDB Developer Guide.
attributesToGet
- This is a legacy parameter. Use ProjectionExpression
instead. For more information, see
Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.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.
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.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.
true
, then a strongly consistent read is
used; otherwise, an eventually consistent read is used.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.
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.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.
true
, then a strongly consistent read is
used; otherwise, an eventually consistent read is used.public void setProjectionExpression(String projectionExpression)
A string that identifies 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 ProjectionExpression
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.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
projectionExpression
- A string that identifies 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 ProjectionExpression
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.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public String getProjectionExpression()
A string that identifies 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 ProjectionExpression
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.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression
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.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public KeysAndAttributes withProjectionExpression(String projectionExpression)
A string that identifies 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 ProjectionExpression
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.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
projectionExpression
- A string that identifies 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 ProjectionExpression
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.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public Map<String,String> getExpressionAttributeNames()
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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public void setExpressionAttributeNames(Map<String,String> 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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public KeysAndAttributes withExpressionAttributeNames(Map<String,String> 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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public KeysAndAttributes addExpressionAttributeNamesEntry(String key, String value)
public KeysAndAttributes clearExpressionAttributeNamesEntries()
public String toString()
toString
in class Object
Object.toString()
public KeysAndAttributes clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.