Java tutorial
/* * Copyright 2014-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 javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * <p> * Represents the input of a <code>GetItem</code> operation. * </p> * * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/GetItem" target="_top">AWS API * Documentation</a> */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class GetItemRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** * <p> * The name of the table containing the requested item. * </p> */ private String tableName; /** * <p> * A map of attribute names to <code>AttributeValue</code> objects, representing the primary key of the item to * retrieve. * </p> * <p> * 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. * </p> */ private java.util.Map<String, AttributeValue> key; /** * <p> * This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html" * >AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> */ private java.util.List<String> attributesToGet; /** * <p> * Determines the read consistency model: If set to <code>true</code>, then the operation uses strongly consistent * reads; otherwise, the operation uses eventually consistent reads. * </p> */ private Boolean consistentRead; private String returnConsumedCapacity; /** * <p> * 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. * </p> * <p> * If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not * found, they do not appear in the result. * </p> * <p> * For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html" * >Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> */ private String projectionExpression; /** * <p> * One or more substitution tokens for attribute names in an expression. The following are some use cases for using * <code>ExpressionAttributeNames</code>: * </p> * <ul> * <li> * <p> * To access an attribute whose name conflicts with a DynamoDB reserved word. * </p> * </li> * <li> * <p> * To create a placeholder for repeating occurrences of an attribute name in an expression. * </p> * </li> * <li> * <p> * To prevent special characters in an attribute name from being misinterpreted in an expression. * </p> * </li> * </ul> * <p> * Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following * attribute name: * </p> * <ul> * <li> * <p> * <code>Percentile</code> * </p> * </li> * </ul> * <p> * 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 <a * href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in * the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for * <code>ExpressionAttributeNames</code>: * </p> * <ul> * <li> * <p> * <code>{"#P":"Percentile"}</code> * </p> * </li> * </ul> * <p> * You could then use this substitution in an expression, as in this example: * </p> * <ul> * <li> * <p> * <code>#P = :val</code> * </p> * </li> * </ul> * <note> * <p> * Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for * the actual value at runtime. * </p> * </note> * <p> * For more information on expression attribute names, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html" * >Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> */ private java.util.Map<String, String> expressionAttributeNames; /** * Default constructor for GetItemRequest object. Callers should use the setter or fluent setter (with...) methods * to initialize the object after creating it. */ 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 <code>AttributeValue</code> objects, representing the primary key of the item * to retrieve.</p> * <p> * 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<String, AttributeValue> 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 <code>AttributeValue</code> objects, representing the primary key of the item * to retrieve.</p> * <p> * 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 <code>true</code>, then the operation uses strongly * consistent reads; otherwise, the operation uses eventually consistent reads. */ public GetItemRequest(String tableName, java.util.Map<String, AttributeValue> key, Boolean consistentRead) { setTableName(tableName); setKey(key); setConsistentRead(consistentRead); } /** * <p> * The name of the table containing the requested item. * </p> * * @param tableName * The name of the table containing the requested item. */ public void setTableName(String tableName) { this.tableName = tableName; } /** * <p> * The name of the table containing the requested item. * </p> * * @return The name of the table containing the requested item. */ public String getTableName() { return this.tableName; } /** * <p> * The name of the table containing the requested item. * </p> * * @param tableName * The name of the table containing the requested item. * @return Returns a reference to this object so that method calls can be chained together. */ public GetItemRequest withTableName(String tableName) { setTableName(tableName); return this; } /** * <p> * A map of attribute names to <code>AttributeValue</code> objects, representing the primary key of the item to * retrieve. * </p> * <p> * 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. * </p> * * @return A map of attribute names to <code>AttributeValue</code> objects, representing the primary key of the item * to retrieve.</p> * <p> * 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<String, AttributeValue> getKey() { return key; } /** * <p> * A map of attribute names to <code>AttributeValue</code> objects, representing the primary key of the item to * retrieve. * </p> * <p> * 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. * </p> * * @param key * A map of attribute names to <code>AttributeValue</code> objects, representing the primary key of the item * to retrieve.</p> * <p> * 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<String, AttributeValue> key) { this.key = key; } /** * <p> * A map of attribute names to <code>AttributeValue</code> objects, representing the primary key of the item to * retrieve. * </p> * <p> * 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. * </p> * * @param key * A map of attribute names to <code>AttributeValue</code> objects, representing the primary key of the item * to retrieve.</p> * <p> * 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 Returns a reference to this object so that method calls can be chained together. */ public GetItemRequest withKey(java.util.Map<String, AttributeValue> key) { setKey(key); return this; } public GetItemRequest addKeyEntry(String key, AttributeValue value) { if (null == this.key) { this.key = new java.util.HashMap<String, AttributeValue>(); } 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. * * @return Returns a reference to this object so that method calls can be chained together. */ public GetItemRequest clearKeyEntries() { this.key = null; return this; } /** * <p> * This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html" * >AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * * @return This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a * href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html" * >AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>. */ public java.util.List<String> getAttributesToGet() { return attributesToGet; } /** * <p> * This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html" * >AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * * @param attributesToGet * This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a * href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html" * >AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>. */ public void setAttributesToGet(java.util.Collection<String> attributesToGet) { if (attributesToGet == null) { this.attributesToGet = null; return; } this.attributesToGet = new java.util.ArrayList<String>(attributesToGet); } /** * <p> * This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html" * >AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * <p> * <b>NOTE:</b> This method appends the values to the existing list (if any). Use * {@link #setAttributesToGet(java.util.Collection)} or {@link #withAttributesToGet(java.util.Collection)} if you * want to override the existing values. * </p> * * @param attributesToGet * This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a * href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html" * >AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>. * @return Returns a reference to this object so that method calls can be chained together. */ public GetItemRequest withAttributesToGet(String... attributesToGet) { if (this.attributesToGet == null) { setAttributesToGet(new java.util.ArrayList<String>(attributesToGet.length)); } for (String ele : attributesToGet) { this.attributesToGet.add(ele); } return this; } /** * <p> * This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html" * >AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * * @param attributesToGet * This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a * href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html" * >AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>. * @return Returns a reference to this object so that method calls can be chained together. */ public GetItemRequest withAttributesToGet(java.util.Collection<String> attributesToGet) { setAttributesToGet(attributesToGet); return this; } /** * <p> * Determines the read consistency model: If set to <code>true</code>, then the operation uses strongly consistent * reads; otherwise, the operation uses eventually consistent reads. * </p> * * @param consistentRead * Determines the read consistency model: If set to <code>true</code>, then the operation uses strongly * consistent reads; otherwise, the operation uses eventually consistent reads. */ public void setConsistentRead(Boolean consistentRead) { this.consistentRead = consistentRead; } /** * <p> * Determines the read consistency model: If set to <code>true</code>, then the operation uses strongly consistent * reads; otherwise, the operation uses eventually consistent reads. * </p> * * @return Determines the read consistency model: If set to <code>true</code>, then the operation uses strongly * consistent reads; otherwise, the operation uses eventually consistent reads. */ public Boolean getConsistentRead() { return this.consistentRead; } /** * <p> * Determines the read consistency model: If set to <code>true</code>, then the operation uses strongly consistent * reads; otherwise, the operation uses eventually consistent reads. * </p> * * @param consistentRead * Determines the read consistency model: If set to <code>true</code>, then the operation uses strongly * consistent reads; otherwise, the operation uses eventually consistent reads. * @return Returns a reference to this object so that method calls can be chained together. */ public GetItemRequest withConsistentRead(Boolean consistentRead) { setConsistentRead(consistentRead); return this; } /** * <p> * Determines the read consistency model: If set to <code>true</code>, then the operation uses strongly consistent * reads; otherwise, the operation uses eventually consistent reads. * </p> * * @return Determines the read consistency model: If set to <code>true</code>, then the operation uses strongly * consistent reads; otherwise, the operation uses eventually consistent reads. */ public Boolean isConsistentRead() { return this.consistentRead; } /** * @param returnConsumedCapacity * @see ReturnConsumedCapacity */ public void setReturnConsumedCapacity(String returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity; } /** * @return * @see ReturnConsumedCapacity */ public String getReturnConsumedCapacity() { return this.returnConsumedCapacity; } /** * @param returnConsumedCapacity * @return Returns a reference to this object so that method calls can be chained together. * @see ReturnConsumedCapacity */ public GetItemRequest withReturnConsumedCapacity(String returnConsumedCapacity) { setReturnConsumedCapacity(returnConsumedCapacity); return this; } /** * @param returnConsumedCapacity * @see ReturnConsumedCapacity */ public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) { withReturnConsumedCapacity(returnConsumedCapacity); } /** * @param returnConsumedCapacity * @return Returns a reference to this object so that method calls can be chained together. * @see ReturnConsumedCapacity */ public GetItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity.toString(); return this; } /** * <p> * 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. * </p> * <p> * If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not * found, they do not appear in the result. * </p> * <p> * For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html" * >Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * * @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.</p> * <p> * If no attribute names are specified, then all attributes are returned. If any of the requested attributes * are not found, they do not appear in the result. * </p> * <p> * For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html" * >Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. */ public void setProjectionExpression(String projectionExpression) { this.projectionExpression = projectionExpression; } /** * <p> * 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. * </p> * <p> * If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not * found, they do not appear in the result. * </p> * <p> * For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html" * >Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * * @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.</p> * <p> * If no attribute names are specified, then all attributes are returned. If any of the requested attributes * are not found, they do not appear in the result. * </p> * <p> * For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html" * >Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. */ public String getProjectionExpression() { return this.projectionExpression; } /** * <p> * 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. * </p> * <p> * If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not * found, they do not appear in the result. * </p> * <p> * For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html" * >Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * * @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.</p> * <p> * If no attribute names are specified, then all attributes are returned. If any of the requested attributes * are not found, they do not appear in the result. * </p> * <p> * For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html" * >Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. * @return Returns a reference to this object so that method calls can be chained together. */ public GetItemRequest withProjectionExpression(String projectionExpression) { setProjectionExpression(projectionExpression); return this; } /** * <p> * One or more substitution tokens for attribute names in an expression. The following are some use cases for using * <code>ExpressionAttributeNames</code>: * </p> * <ul> * <li> * <p> * To access an attribute whose name conflicts with a DynamoDB reserved word. * </p> * </li> * <li> * <p> * To create a placeholder for repeating occurrences of an attribute name in an expression. * </p> * </li> * <li> * <p> * To prevent special characters in an attribute name from being misinterpreted in an expression. * </p> * </li> * </ul> * <p> * Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following * attribute name: * </p> * <ul> * <li> * <p> * <code>Percentile</code> * </p> * </li> * </ul> * <p> * 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 <a * href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in * the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for * <code>ExpressionAttributeNames</code>: * </p> * <ul> * <li> * <p> * <code>{"#P":"Percentile"}</code> * </p> * </li> * </ul> * <p> * You could then use this substitution in an expression, as in this example: * </p> * <ul> * <li> * <p> * <code>#P = :val</code> * </p> * </li> * </ul> * <note> * <p> * Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for * the actual value at runtime. * </p> * </note> * <p> * For more information on expression attribute names, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html" * >Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * * @return One or more substitution tokens for attribute names in an expression. The following are some use cases * for using <code>ExpressionAttributeNames</code>:</p> * <ul> * <li> * <p> * To access an attribute whose name conflicts with a DynamoDB reserved word. * </p> * </li> * <li> * <p> * To create a placeholder for repeating occurrences of an attribute name in an expression. * </p> * </li> * <li> * <p> * To prevent special characters in an attribute name from being misinterpreted in an expression. * </p> * </li> * </ul> * <p> * Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the * following attribute name: * </p> * <ul> * <li> * <p> * <code>Percentile</code> * </p> * </li> * </ul> * <p> * 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 <a * href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved * Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the * following for <code>ExpressionAttributeNames</code>: * </p> * <ul> * <li> * <p> * <code>{"#P":"Percentile"}</code> * </p> * </li> * </ul> * <p> * You could then use this substitution in an expression, as in this example: * </p> * <ul> * <li> * <p> * <code>#P = :val</code> * </p> * </li> * </ul> * <note> * <p> * Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are * placeholders for the actual value at runtime. * </p> * </note> * <p> * For more information on expression attribute names, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html" * >Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. */ public java.util.Map<String, String> getExpressionAttributeNames() { return expressionAttributeNames; } /** * <p> * One or more substitution tokens for attribute names in an expression. The following are some use cases for using * <code>ExpressionAttributeNames</code>: * </p> * <ul> * <li> * <p> * To access an attribute whose name conflicts with a DynamoDB reserved word. * </p> * </li> * <li> * <p> * To create a placeholder for repeating occurrences of an attribute name in an expression. * </p> * </li> * <li> * <p> * To prevent special characters in an attribute name from being misinterpreted in an expression. * </p> * </li> * </ul> * <p> * Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following * attribute name: * </p> * <ul> * <li> * <p> * <code>Percentile</code> * </p> * </li> * </ul> * <p> * 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 <a * href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in * the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for * <code>ExpressionAttributeNames</code>: * </p> * <ul> * <li> * <p> * <code>{"#P":"Percentile"}</code> * </p> * </li> * </ul> * <p> * You could then use this substitution in an expression, as in this example: * </p> * <ul> * <li> * <p> * <code>#P = :val</code> * </p> * </li> * </ul> * <note> * <p> * Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for * the actual value at runtime. * </p> * </note> * <p> * For more information on expression attribute names, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html" * >Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * * @param expressionAttributeNames * One or more substitution tokens for attribute names in an expression. The following are some use cases for * using <code>ExpressionAttributeNames</code>:</p> * <ul> * <li> * <p> * To access an attribute whose name conflicts with a DynamoDB reserved word. * </p> * </li> * <li> * <p> * To create a placeholder for repeating occurrences of an attribute name in an expression. * </p> * </li> * <li> * <p> * To prevent special characters in an attribute name from being misinterpreted in an expression. * </p> * </li> * </ul> * <p> * Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the * following attribute name: * </p> * <ul> * <li> * <p> * <code>Percentile</code> * </p> * </li> * </ul> * <p> * 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 <a * href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved * Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the * following for <code>ExpressionAttributeNames</code>: * </p> * <ul> * <li> * <p> * <code>{"#P":"Percentile"}</code> * </p> * </li> * </ul> * <p> * You could then use this substitution in an expression, as in this example: * </p> * <ul> * <li> * <p> * <code>#P = :val</code> * </p> * </li> * </ul> * <note> * <p> * Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are * placeholders for the actual value at runtime. * </p> * </note> * <p> * For more information on expression attribute names, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html" * >Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. */ public void setExpressionAttributeNames(java.util.Map<String, String> expressionAttributeNames) { this.expressionAttributeNames = expressionAttributeNames; } /** * <p> * One or more substitution tokens for attribute names in an expression. The following are some use cases for using * <code>ExpressionAttributeNames</code>: * </p> * <ul> * <li> * <p> * To access an attribute whose name conflicts with a DynamoDB reserved word. * </p> * </li> * <li> * <p> * To create a placeholder for repeating occurrences of an attribute name in an expression. * </p> * </li> * <li> * <p> * To prevent special characters in an attribute name from being misinterpreted in an expression. * </p> * </li> * </ul> * <p> * Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following * attribute name: * </p> * <ul> * <li> * <p> * <code>Percentile</code> * </p> * </li> * </ul> * <p> * 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 <a * href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in * the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for * <code>ExpressionAttributeNames</code>: * </p> * <ul> * <li> * <p> * <code>{"#P":"Percentile"}</code> * </p> * </li> * </ul> * <p> * You could then use this substitution in an expression, as in this example: * </p> * <ul> * <li> * <p> * <code>#P = :val</code> * </p> * </li> * </ul> * <note> * <p> * Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for * the actual value at runtime. * </p> * </note> * <p> * For more information on expression attribute names, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html" * >Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * * @param expressionAttributeNames * One or more substitution tokens for attribute names in an expression. The following are some use cases for * using <code>ExpressionAttributeNames</code>:</p> * <ul> * <li> * <p> * To access an attribute whose name conflicts with a DynamoDB reserved word. * </p> * </li> * <li> * <p> * To create a placeholder for repeating occurrences of an attribute name in an expression. * </p> * </li> * <li> * <p> * To prevent special characters in an attribute name from being misinterpreted in an expression. * </p> * </li> * </ul> * <p> * Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the * following attribute name: * </p> * <ul> * <li> * <p> * <code>Percentile</code> * </p> * </li> * </ul> * <p> * 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 <a * href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved * Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the * following for <code>ExpressionAttributeNames</code>: * </p> * <ul> * <li> * <p> * <code>{"#P":"Percentile"}</code> * </p> * </li> * </ul> * <p> * You could then use this substitution in an expression, as in this example: * </p> * <ul> * <li> * <p> * <code>#P = :val</code> * </p> * </li> * </ul> * <note> * <p> * Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are * placeholders for the actual value at runtime. * </p> * </note> * <p> * For more information on expression attribute names, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html" * >Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. * @return Returns a reference to this object so that method calls can be chained together. */ public GetItemRequest withExpressionAttributeNames(java.util.Map<String, String> expressionAttributeNames) { setExpressionAttributeNames(expressionAttributeNames); return this; } public GetItemRequest addExpressionAttributeNamesEntry(String key, String value) { if (null == this.expressionAttributeNames) { this.expressionAttributeNames = new java.util.HashMap<String, String>(); } 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. * * @return Returns a reference to this object so that method calls can be chained together. */ public GetItemRequest clearExpressionAttributeNamesEntries() { this.expressionAttributeNames = null; return this; } /** * Set the hash and range key attributes of the item. * <p> * For a hash-only table, you only need to provide the hash attribute. For a hash-and-range table, you must provide * both. * * @param hashKey * a map entry including the name and value of the primary hash key. * @param rangeKey * a map entry including the name and value of the primary range key, or null if it is a hash-only table. */ public void setKey(java.util.Map.Entry<String, AttributeValue> hashKey, java.util.Map.Entry<String, AttributeValue> rangeKey) throws IllegalArgumentException { java.util.HashMap<String, AttributeValue> key = new java.util.HashMap<String, AttributeValue>(); if (hashKey != null) { key.put(hashKey.getKey(), hashKey.getValue()); } else { throw new IllegalArgumentException("hashKey must be non-null object."); } if (rangeKey != null) { key.put(rangeKey.getKey(), rangeKey.getValue()); } setKey(key); } /** * Set the hash and range key attributes of the item. * <p> * For a hash-only table, you only need to provide the hash attribute. For a hash-and-range table, you must provide * both. * <p> * Returns a reference to this object so that method calls can be chained together. * * @param hashKey * a map entry including the name and value of the primary hash key. * @param rangeKey * a map entry including the name and value of the primary range key, or null if it is a hash-only table. */ public GetItemRequest withKey(java.util.Map.Entry<String, AttributeValue> hashKey, java.util.Map.Entry<String, AttributeValue> rangeKey) throws IllegalArgumentException { setKey(hashKey, rangeKey); return this; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @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: ").append(getTableName()).append(","); if (getKey() != null) sb.append("Key: ").append(getKey()).append(","); if (getAttributesToGet() != null) sb.append("AttributesToGet: ").append(getAttributesToGet()).append(","); if (getConsistentRead() != null) sb.append("ConsistentRead: ").append(getConsistentRead()).append(","); if (getReturnConsumedCapacity() != null) sb.append("ReturnConsumedCapacity: ").append(getReturnConsumedCapacity()).append(","); if (getProjectionExpression() != null) sb.append("ProjectionExpression: ").append(getProjectionExpression()).append(","); if (getExpressionAttributeNames() != null) sb.append("ExpressionAttributeNames: ").append(getExpressionAttributeNames()); sb.append("}"); return sb.toString(); } @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; } @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 GetItemRequest clone() { return (GetItemRequest) super.clone(); } }