/* * Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.dynamodbv2.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* The GetItem operation returns a set of attributes for the item * with the given primary key. If there is no matching item, * GetItem does not return any data and there will be no * Item element in the response. *

*

* GetItem provides an eventually consistent read by default. If * your application requires a strongly consistent read, set * ConsistentRead to true. Although a strongly * consistent read might take more time than an eventually consistent read, it * always returns the last updated value. *

*/ public class GetItemRequest extends AmazonWebServiceRequest implements Serializable { /** *

* The name of the table containing the requested item. *

*

* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
*/ private String tableName; /** *

* A map of attribute names to AttributeValue objects, * representing the primary key of the item to retrieve. *

*

* For the primary key, you must provide all of the attributes. For example, * with a simple primary key, you only need to provide a value for the * partition key. For a composite primary key, you must provide values for * both the partition key and the sort key. *

*/ private java.util.Map key; /** *

* This is a legacy parameter. Use ProjectionExpression * instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide. *

*/ private java.util.List attributesToGet; /** *

* Determines the read consistency model: If set to true, then * the operation uses strongly consistent reads; otherwise, the operation * uses eventually consistent reads. *

*/ private Boolean consistentRead; /** *

* Determines the level of detail about provisioned throughput consumption * that is returned in the response: *

* *

* Constraints:
* Allowed Values: INDEXES, TOTAL, NONE */ private String returnConsumedCapacity; /** *

* 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 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. *

*

* For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer * Guide. *

*/ private String projectionExpression; /** *

* One or more substitution tokens for attribute names in an expression. The * following are some use cases for using * ExpressionAttributeNames: *

* *

* Use the # character in an expression to dereference an attribute * name. For example, consider the following attribute name: *

* *

* 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: *

* *

* You could then use this substitution in an expression, as in this * example: *

* * *

* 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. *

*/ private java.util.Map expressionAttributeNames; /** * Default constructor for GetItemRequest object. Callers should use the * setter or fluent setter (with...) methods to initialize any additional * object members. */ public GetItemRequest() { } /** * Constructs a new GetItemRequest object. Callers should use the setter or * fluent setter (with...) methods to initialize any additional object * members. * * @param tableName

* The name of the table containing the requested item. *

* @param key

* A map of attribute names to AttributeValue * objects, representing the primary key of the item to retrieve. *

*

* For the primary key, you must provide all of the attributes. * For example, with a simple primary key, you only need to * provide a value for the partition key. For a composite primary * key, you must provide values for both the partition key and * the sort key. *

*/ public GetItemRequest(String tableName, java.util.Map key) { setTableName(tableName); setKey(key); } /** * Constructs a new GetItemRequest object. Callers should use the setter or * fluent setter (with...) methods to initialize any additional object * members. * * @param tableName

* The name of the table containing the requested item. *

* @param key

* A map of attribute names to AttributeValue * objects, representing the primary key of the item to retrieve. *

*

* For the primary key, you must provide all of the attributes. * For example, with a simple primary key, you only need to * provide a value for the partition key. For a composite primary * key, you must provide values for both the partition key and * the sort key. *

* @param consistentRead

* Determines the read consistency model: If set to * true, then the operation uses strongly consistent * reads; otherwise, the operation uses eventually consistent * reads. *

*/ public GetItemRequest(String tableName, java.util.Map key, Boolean consistentRead) { setTableName(tableName); setKey(key); setConsistentRead(consistentRead); } /** *

* The name of the table containing the requested item. *

*

* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
* * @return

* The name of the table containing the requested item. *

*/ public String getTableName() { return tableName; } /** *

* The name of the table containing the requested item. *

*

* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
* * @param tableName

* The name of the table containing the requested item. *

*/ public void setTableName(String tableName) { this.tableName = tableName; } /** *

* The name of the table containing the requested item. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
* * @param tableName

* The name of the table containing the requested item. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetItemRequest withTableName(String tableName) { this.tableName = tableName; return this; } /** *

* A map of attribute names to AttributeValue objects, * representing the primary key of the item to retrieve. *

*

* For the primary key, you must provide all of the attributes. For example, * with a simple primary key, you only need to provide a value for the * partition key. For a composite primary key, you must provide values for * both the partition key and the sort key. *

* * @return

* A map of attribute names to AttributeValue objects, * representing the primary key of the item to retrieve. *

*

* For the primary key, you must provide all of the attributes. For * example, with a simple primary key, you only need to provide a * value for the partition key. For a composite primary key, you * must provide values for both the partition key and the sort key. *

*/ public java.util.Map getKey() { return key; } /** *

* A map of attribute names to AttributeValue objects, * representing the primary key of the item to retrieve. *

*

* For the primary key, you must provide all of the attributes. For example, * with a simple primary key, you only need to provide a value for the * partition key. For a composite primary key, you must provide values for * both the partition key and the sort key. *

* * @param key

* A map of attribute names to AttributeValue * objects, representing the primary key of the item to retrieve. *

*

* For the primary key, you must provide all of the attributes. * For example, with a simple primary key, you only need to * provide a value for the partition key. For a composite primary * key, you must provide values for both the partition key and * the sort key. *

*/ public void setKey(java.util.Map key) { this.key = key; } /** *

* A map of attribute names to AttributeValue objects, * representing the primary key of the item to retrieve. *

*

* For the primary key, you must provide all of the attributes. For example, * with a simple primary key, you only need to provide a value for the * partition key. For a composite primary key, you must provide values for * both the partition key and the sort key. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param key

* A map of attribute names to AttributeValue * objects, representing the primary key of the item to retrieve. *

*

* For the primary key, you must provide all of the attributes. * For example, with a simple primary key, you only need to * provide a value for the partition key. For a composite primary * key, you must provide values for both the partition key and * the sort key. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetItemRequest withKey(java.util.Map key) { this.key = key; return this; } /** *

* A map of attribute names to AttributeValue objects, * representing the primary key of the item to retrieve. *

*

* For the primary key, you must provide all of the attributes. For example, * with a simple primary key, you only need to provide a value for the * partition key. For a composite primary key, you must provide values for * both the partition key and the sort key. *

*

* The method adds a new key-value pair into Key parameter, and returns a * reference to this object so that method calls can be chained together. * * @param key The key of the entry to be added into Key. * @param value The corresponding value of the entry to be added into Key. * @return A reference to this updated object so that method calls can be * chained together. */ public GetItemRequest addKeyEntry(String key, AttributeValue value) { if (null == this.key) { this.key = new java.util.HashMap(); } if (this.key.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.key.put(key, value); return this; } /** * Removes all the entries added into Key. *

* Returns a reference to this object so that method calls can be chained * together. */ public GetItemRequest clearKeyEntries() { this.key = null; return this; } /** *

* This is a legacy parameter. Use ProjectionExpression * instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide. *

* * @return

* This is a legacy parameter. Use ProjectionExpression * instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer * Guide. *

*/ public java.util.List getAttributesToGet() { return attributesToGet; } /** *

* This is a legacy parameter. Use ProjectionExpression * instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide. *

* * @param attributesToGet

* This is a legacy parameter. Use * ProjectionExpression instead. For more * information, see AttributesToGet in the Amazon DynamoDB Developer * Guide. *

*/ public void setAttributesToGet(java.util.Collection attributesToGet) { if (attributesToGet == null) { this.attributesToGet = null; return; } this.attributesToGet = new java.util.ArrayList(attributesToGet); } /** *

* This is a legacy parameter. Use ProjectionExpression * instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param attributesToGet

* This is a legacy parameter. Use * ProjectionExpression instead. For more * information, see AttributesToGet in the Amazon DynamoDB Developer * Guide. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetItemRequest withAttributesToGet(String... attributesToGet) { if (getAttributesToGet() == null) { this.attributesToGet = new java.util.ArrayList(attributesToGet.length); } for (String value : attributesToGet) { this.attributesToGet.add(value); } return this; } /** *

* This is a legacy parameter. Use ProjectionExpression * instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param attributesToGet

* This is a legacy parameter. Use * ProjectionExpression instead. For more * information, see AttributesToGet in the Amazon DynamoDB Developer * Guide. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetItemRequest withAttributesToGet(java.util.Collection attributesToGet) { setAttributesToGet(attributesToGet); return this; } /** *

* Determines the read consistency model: If set to true, then * the operation uses strongly consistent reads; otherwise, the operation * uses eventually consistent reads. *

* * @return

* Determines the read consistency model: If set to * true, then the operation uses strongly consistent * reads; otherwise, the operation uses eventually consistent reads. *

*/ public Boolean isConsistentRead() { return consistentRead; } /** *

* Determines the read consistency model: If set to true, then * the operation uses strongly consistent reads; otherwise, the operation * uses eventually consistent reads. *

* * @return

* Determines the read consistency model: If set to * true, then the operation uses strongly consistent * reads; otherwise, the operation uses eventually consistent reads. *

*/ public Boolean getConsistentRead() { return consistentRead; } /** *

* Determines the read consistency model: If set to true, then * the operation uses strongly consistent reads; otherwise, the operation * uses eventually consistent reads. *

* * @param consistentRead

* Determines the read consistency model: If set to * true, then the operation uses strongly consistent * reads; otherwise, the operation uses eventually consistent * reads. *

*/ public void setConsistentRead(Boolean consistentRead) { this.consistentRead = consistentRead; } /** *

* Determines the read consistency model: If set to true, then * the operation uses strongly consistent reads; otherwise, the operation * uses eventually consistent reads. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param consistentRead

* Determines the read consistency model: If set to * true, then the operation uses strongly consistent * reads; otherwise, the operation uses eventually consistent * reads. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetItemRequest withConsistentRead(Boolean consistentRead) { this.consistentRead = consistentRead; return this; } /** *

* Determines the level of detail about provisioned throughput consumption * that is returned in the response: *

*
    *
  • *

    * INDEXES - The response includes the aggregate * ConsumedCapacity for the operation, together with * ConsumedCapacity for each table and secondary index that was * accessed. *

    *

    * Note that some operations, such as GetItem and * BatchGetItem, do not access any indexes at all. In these * cases, specifying INDEXES will only return * ConsumedCapacity information for table(s). *

    *
  • *
  • *

    * TOTAL - The response includes only the aggregate * ConsumedCapacity for the operation. *

    *
  • *
  • *

    * NONE - No ConsumedCapacity details are included * in the response. *

    *
  • *
*

* Constraints:
* Allowed Values: INDEXES, TOTAL, NONE * * @return

* Determines the level of detail about provisioned throughput * consumption that is returned in the response: *

*
    *
  • *

    * INDEXES - The response includes the aggregate * ConsumedCapacity for the operation, together with * ConsumedCapacity for each table and secondary index * that was accessed. *

    *

    * Note that some operations, such as GetItem and * BatchGetItem, do not access any indexes at all. In * these cases, specifying INDEXES will only return * ConsumedCapacity information for table(s). *

    *
  • *
  • *

    * TOTAL - The response includes only the aggregate * ConsumedCapacity for the operation. *

    *
  • *
  • *

    * NONE - No ConsumedCapacity details are * included in the response. *

    *
  • *
* @see ReturnConsumedCapacity */ public String getReturnConsumedCapacity() { return returnConsumedCapacity; } /** *

* Determines the level of detail about provisioned throughput consumption * that is returned in the response: *

*
    *
  • *

    * INDEXES - The response includes the aggregate * ConsumedCapacity for the operation, together with * ConsumedCapacity for each table and secondary index that was * accessed. *

    *

    * Note that some operations, such as GetItem and * BatchGetItem, do not access any indexes at all. In these * cases, specifying INDEXES will only return * ConsumedCapacity information for table(s). *

    *
  • *
  • *

    * TOTAL - The response includes only the aggregate * ConsumedCapacity for the operation. *

    *
  • *
  • *

    * NONE - No ConsumedCapacity details are included * in the response. *

    *
  • *
*

* Constraints:
* Allowed Values: INDEXES, TOTAL, NONE * * @param returnConsumedCapacity

* Determines the level of detail about provisioned throughput * consumption that is returned in the response: *

*
    *
  • *

    * INDEXES - The response includes the aggregate * ConsumedCapacity for the operation, together with * ConsumedCapacity for each table and secondary * index that was accessed. *

    *

    * Note that some operations, such as GetItem and * BatchGetItem, do not access any indexes at all. * In these cases, specifying INDEXES will only * return ConsumedCapacity information for table(s). *

    *
  • *
  • *

    * TOTAL - The response includes only the aggregate * ConsumedCapacity for the operation. *

    *
  • *
  • *

    * NONE - No ConsumedCapacity details * are included in the response. *

    *
  • *
* @see ReturnConsumedCapacity */ public void setReturnConsumedCapacity(String returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity; } /** *

* Determines the level of detail about provisioned throughput consumption * that is returned in the response: *

*
    *
  • *

    * INDEXES - The response includes the aggregate * ConsumedCapacity for the operation, together with * ConsumedCapacity for each table and secondary index that was * accessed. *

    *

    * Note that some operations, such as GetItem and * BatchGetItem, do not access any indexes at all. In these * cases, specifying INDEXES will only return * ConsumedCapacity information for table(s). *

    *
  • *
  • *

    * TOTAL - The response includes only the aggregate * ConsumedCapacity for the operation. *

    *
  • *
  • *

    * NONE - No ConsumedCapacity details are included * in the response. *

    *
  • *
*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: INDEXES, TOTAL, NONE * * @param returnConsumedCapacity

* Determines the level of detail about provisioned throughput * consumption that is returned in the response: *

*
    *
  • *

    * INDEXES - The response includes the aggregate * ConsumedCapacity for the operation, together with * ConsumedCapacity for each table and secondary * index that was accessed. *

    *

    * Note that some operations, such as GetItem and * BatchGetItem, do not access any indexes at all. * In these cases, specifying INDEXES will only * return ConsumedCapacity information for table(s). *

    *
  • *
  • *

    * TOTAL - The response includes only the aggregate * ConsumedCapacity for the operation. *

    *
  • *
  • *

    * NONE - No ConsumedCapacity details * are included in the response. *

    *
  • *
* @return A reference to this updated object so that method calls can be * chained together. * @see ReturnConsumedCapacity */ public GetItemRequest withReturnConsumedCapacity(String returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity; return this; } /** *

* Determines the level of detail about provisioned throughput consumption * that is returned in the response: *

*
    *
  • *

    * INDEXES - The response includes the aggregate * ConsumedCapacity for the operation, together with * ConsumedCapacity for each table and secondary index that was * accessed. *

    *

    * Note that some operations, such as GetItem and * BatchGetItem, do not access any indexes at all. In these * cases, specifying INDEXES will only return * ConsumedCapacity information for table(s). *

    *
  • *
  • *

    * TOTAL - The response includes only the aggregate * ConsumedCapacity for the operation. *

    *
  • *
  • *

    * NONE - No ConsumedCapacity details are included * in the response. *

    *
  • *
*

* Constraints:
* Allowed Values: INDEXES, TOTAL, NONE * * @param returnConsumedCapacity

* Determines the level of detail about provisioned throughput * consumption that is returned in the response: *

*
    *
  • *

    * INDEXES - The response includes the aggregate * ConsumedCapacity for the operation, together with * ConsumedCapacity for each table and secondary * index that was accessed. *

    *

    * Note that some operations, such as GetItem and * BatchGetItem, do not access any indexes at all. * In these cases, specifying INDEXES will only * return ConsumedCapacity information for table(s). *

    *
  • *
  • *

    * TOTAL - The response includes only the aggregate * ConsumedCapacity for the operation. *

    *
  • *
  • *

    * NONE - No ConsumedCapacity details * are included in the response. *

    *
  • *
* @see ReturnConsumedCapacity */ public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity.toString(); } /** *

* Determines the level of detail about provisioned throughput consumption * that is returned in the response: *

*
    *
  • *

    * INDEXES - The response includes the aggregate * ConsumedCapacity for the operation, together with * ConsumedCapacity for each table and secondary index that was * accessed. *

    *

    * Note that some operations, such as GetItem and * BatchGetItem, do not access any indexes at all. In these * cases, specifying INDEXES will only return * ConsumedCapacity information for table(s). *

    *
  • *
  • *

    * TOTAL - The response includes only the aggregate * ConsumedCapacity for the operation. *

    *
  • *
  • *

    * NONE - No ConsumedCapacity details are included * in the response. *

    *
  • *
*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: INDEXES, TOTAL, NONE * * @param returnConsumedCapacity

* Determines the level of detail about provisioned throughput * consumption that is returned in the response: *

*
    *
  • *

    * INDEXES - The response includes the aggregate * ConsumedCapacity for the operation, together with * ConsumedCapacity for each table and secondary * index that was accessed. *

    *

    * Note that some operations, such as GetItem and * BatchGetItem, do not access any indexes at all. * In these cases, specifying INDEXES will only * return ConsumedCapacity information for table(s). *

    *
  • *
  • *

    * TOTAL - The response includes only the aggregate * ConsumedCapacity for the operation. *

    *
  • *
  • *

    * NONE - No ConsumedCapacity details * are included in the response. *

    *
  • *
* @return A reference to this updated object so that method calls can be * chained together. * @see ReturnConsumedCapacity */ public GetItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity.toString(); return this; } /** *

* 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 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. *

*

* For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer * Guide. *

* * @return

* 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 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. *

*

* For more information, see Accessing Item Attributes in the Amazon DynamoDB * Developer Guide. *

*/ public String getProjectionExpression() { return 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 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. *

*

* For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer * Guide. *

* * @param 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 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. *

*

* For more information, see Accessing Item Attributes in the Amazon DynamoDB * Developer Guide. *

*/ public void setProjectionExpression(String projectionExpression) { this.projectionExpression = 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 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. *

*

* For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer * Guide. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param 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 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. *

*

* For more information, see Accessing Item Attributes in the Amazon DynamoDB * Developer Guide. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetItemRequest withProjectionExpression(String projectionExpression) { this.projectionExpression = projectionExpression; return this; } /** *

* 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. *

* * @return

* 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 java.util.Map getExpressionAttributeNames() { return 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. *

* * @param 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 void setExpressionAttributeNames(java.util.Map expressionAttributeNames) { this.expressionAttributeNames = 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. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetItemRequest withExpressionAttributeNames( java.util.Map expressionAttributeNames) { this.expressionAttributeNames = expressionAttributeNames; return this; } /** *

* 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. *

*

* 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. * * @param key The key of the entry to be added into * ExpressionAttributeNames. * @param value The corresponding value of the entry to be added into * ExpressionAttributeNames. * @return A reference to this updated object so that method calls can be * chained together. */ public GetItemRequest addExpressionAttributeNamesEntry(String key, String value) { if (null == this.expressionAttributeNames) { this.expressionAttributeNames = new java.util.HashMap(); } if (this.expressionAttributeNames.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.expressionAttributeNames.put(key, value); return this; } /** * Removes all the entries added into ExpressionAttributeNames. *

* Returns a reference to this object so that method calls can be chained * together. */ public GetItemRequest clearExpressionAttributeNamesEntries() { this.expressionAttributeNames = null; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getTableName() != null) sb.append("TableName: " + getTableName() + ","); if (getKey() != null) sb.append("Key: " + getKey() + ","); if (getAttributesToGet() != null) sb.append("AttributesToGet: " + getAttributesToGet() + ","); if (getConsistentRead() != null) sb.append("ConsistentRead: " + getConsistentRead() + ","); if (getReturnConsumedCapacity() != null) sb.append("ReturnConsumedCapacity: " + getReturnConsumedCapacity() + ","); if (getProjectionExpression() != null) sb.append("ProjectionExpression: " + getProjectionExpression() + ","); if (getExpressionAttributeNames() != null) sb.append("ExpressionAttributeNames: " + getExpressionAttributeNames()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getTableName() == null) ? 0 : getTableName().hashCode()); hashCode = prime * hashCode + ((getKey() == null) ? 0 : getKey().hashCode()); hashCode = prime * hashCode + ((getAttributesToGet() == null) ? 0 : getAttributesToGet().hashCode()); hashCode = prime * hashCode + ((getConsistentRead() == null) ? 0 : getConsistentRead().hashCode()); hashCode = prime * hashCode + ((getReturnConsumedCapacity() == null) ? 0 : getReturnConsumedCapacity() .hashCode()); hashCode = prime * hashCode + ((getProjectionExpression() == null) ? 0 : getProjectionExpression().hashCode()); hashCode = prime * hashCode + ((getExpressionAttributeNames() == null) ? 0 : getExpressionAttributeNames() .hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetItemRequest == false) return false; GetItemRequest other = (GetItemRequest) obj; if (other.getTableName() == null ^ this.getTableName() == null) return false; if (other.getTableName() != null && other.getTableName().equals(this.getTableName()) == false) return false; if (other.getKey() == null ^ this.getKey() == null) return false; if (other.getKey() != null && other.getKey().equals(this.getKey()) == false) return false; if (other.getAttributesToGet() == null ^ this.getAttributesToGet() == null) return false; if (other.getAttributesToGet() != null && other.getAttributesToGet().equals(this.getAttributesToGet()) == false) return false; if (other.getConsistentRead() == null ^ this.getConsistentRead() == null) return false; if (other.getConsistentRead() != null && other.getConsistentRead().equals(this.getConsistentRead()) == false) return false; if (other.getReturnConsumedCapacity() == null ^ this.getReturnConsumedCapacity() == null) return false; if (other.getReturnConsumedCapacity() != null && other.getReturnConsumedCapacity().equals(this.getReturnConsumedCapacity()) == false) return false; if (other.getProjectionExpression() == null ^ this.getProjectionExpression() == null) return false; if (other.getProjectionExpression() != null && other.getProjectionExpression().equals(this.getProjectionExpression()) == false) return false; if (other.getExpressionAttributeNames() == null ^ this.getExpressionAttributeNames() == null) return false; if (other.getExpressionAttributeNames() != null && other.getExpressionAttributeNames().equals(this.getExpressionAttributeNames()) == false) return false; return true; } }