com.amazonaws.services.dynamodbv2.model.BatchGetItemRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dynamodb Show documentation
/*
* Copyright 2016-2021 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;
/**
*
* Represents the input of a BatchGetItem operation.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class BatchGetItemRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A map of one or more table names and, for each table, a map that describes one or more items to retrieve from
* that table. Each table name can be used only once per BatchGetItem request.
*
*
* Each element in the map of items to retrieve consists of the following:
*
*
* -
*
* ConsistentRead - If true, a strongly consistent read is used; if false
* (the default), an eventually consistent read is used.
*
*
* -
*
* ExpressionAttributeNames - One or more substitution tokens for attribute names in the
* ProjectionExpression parameter. 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 about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* Keys - An array of primary key attribute values that define specific items in 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 value. For a composite key, you must provide both the partition key
* value and the sort key value.
*
*
* -
*
* 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 are returned. If any of the requested attributes are not
* found, they do not appear in the result.
*
*
* For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For
* more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
*
*
*
*/
private java.util.Map requestItems;
private String returnConsumedCapacity;
/**
* Default constructor for BatchGetItemRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize the object after creating it.
*/
public BatchGetItemRequest() {
}
/**
* Constructs a new BatchGetItemRequest object. Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param requestItems
* A map of one or more table names and, for each table, a map that describes one or more items to retrieve
* from that table. Each table name can be used only once per BatchGetItem request.
*
* Each element in the map of items to retrieve consists of the following:
*
*
* -
*
* ConsistentRead - If true, a strongly consistent read is used; if
* false (the default), an eventually consistent read is used.
*
*
* -
*
* ExpressionAttributeNames - One or more substitution tokens for attribute names in the
* ProjectionExpression parameter. 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 about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* Keys - An array of primary key attribute values that define specific items in 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 value. For a composite key, you must provide both
* the partition key value and the sort key value.
*
*
* -
*
* 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 are returned. If any of the requested attributes
* are not found, they do not appear in the result.
*
*
* For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead.
* For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
*
*
*/
public BatchGetItemRequest(java.util.Map requestItems) {
setRequestItems(requestItems);
}
/**
* Constructs a new BatchGetItemRequest object. Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param requestItems
* A map of one or more table names and, for each table, a map that describes one or more items to retrieve
* from that table. Each table name can be used only once per BatchGetItem request.
*
* Each element in the map of items to retrieve consists of the following:
*
*
* -
*
* ConsistentRead - If true, a strongly consistent read is used; if
* false (the default), an eventually consistent read is used.
*
*
* -
*
* ExpressionAttributeNames - One or more substitution tokens for attribute names in the
* ProjectionExpression parameter. 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 about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* Keys - An array of primary key attribute values that define specific items in 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 value. For a composite key, you must provide both
* the partition key value and the sort key value.
*
*
* -
*
* 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 are returned. If any of the requested attributes
* are not found, they do not appear in the result.
*
*
* For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead.
* For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
*
*
* @param returnConsumedCapacity
*/
public BatchGetItemRequest(java.util.Map requestItems, String returnConsumedCapacity) {
setRequestItems(requestItems);
setReturnConsumedCapacity(returnConsumedCapacity);
}
/**
* Constructs a new BatchGetItemRequest object. Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param requestItems
* A map of one or more table names and, for each table, a map that describes one or more items to retrieve
* from that table. Each table name can be used only once per BatchGetItem request.
*
* Each element in the map of items to retrieve consists of the following:
*
*
* -
*
* ConsistentRead - If true, a strongly consistent read is used; if
* false (the default), an eventually consistent read is used.
*
*
* -
*
* ExpressionAttributeNames - One or more substitution tokens for attribute names in the
* ProjectionExpression parameter. 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 about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* Keys - An array of primary key attribute values that define specific items in 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 value. For a composite key, you must provide both
* the partition key value and the sort key value.
*
*
* -
*
* 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 are returned. If any of the requested attributes
* are not found, they do not appear in the result.
*
*
* For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead.
* For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
*
*
* @param returnConsumedCapacity
*/
public BatchGetItemRequest(java.util.Map requestItems, ReturnConsumedCapacity returnConsumedCapacity) {
setRequestItems(requestItems);
setReturnConsumedCapacity(returnConsumedCapacity.toString());
}
/**
*
* A map of one or more table names and, for each table, a map that describes one or more items to retrieve from
* that table. Each table name can be used only once per BatchGetItem request.
*
*
* Each element in the map of items to retrieve consists of the following:
*
*
* -
*
* ConsistentRead - If true, a strongly consistent read is used; if false
* (the default), an eventually consistent read is used.
*
*
* -
*
* ExpressionAttributeNames - One or more substitution tokens for attribute names in the
* ProjectionExpression parameter. 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 about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* Keys - An array of primary key attribute values that define specific items in 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 value. For a composite key, you must provide both the partition key
* value and the sort key value.
*
*
* -
*
* 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 are returned. If any of the requested attributes are not
* found, they do not appear in the result.
*
*
* For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For
* more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
*
*
*
*
* @return A map of one or more table names and, for each table, a map that describes one or more items to retrieve
* from that table. Each table name can be used only once per BatchGetItem request.
*
* Each element in the map of items to retrieve consists of the following:
*
*
* -
*
* ConsistentRead - If true, a strongly consistent read is used; if
* false (the default), an eventually consistent read is used.
*
*
* -
*
* ExpressionAttributeNames - One or more substitution tokens for attribute names in the
* ProjectionExpression parameter. 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 about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* Keys - An array of primary key attribute values that define specific items in 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 value. For a composite key, you must provide both
* the partition key value and the sort key value.
*
*
* -
*
* 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 are returned. If any of the requested attributes
* are not found, they do not appear in the result.
*
*
* For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead.
* For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
*
*
*/
public java.util.Map getRequestItems() {
return requestItems;
}
/**
*
* A map of one or more table names and, for each table, a map that describes one or more items to retrieve from
* that table. Each table name can be used only once per BatchGetItem request.
*
*
* Each element in the map of items to retrieve consists of the following:
*
*
* -
*
* ConsistentRead - If true, a strongly consistent read is used; if false
* (the default), an eventually consistent read is used.
*
*
* -
*
* ExpressionAttributeNames - One or more substitution tokens for attribute names in the
* ProjectionExpression parameter. 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 about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* Keys - An array of primary key attribute values that define specific items in 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 value. For a composite key, you must provide both the partition key
* value and the sort key value.
*
*
* -
*
* 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 are returned. If any of the requested attributes are not
* found, they do not appear in the result.
*
*
* For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For
* more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
*
*
*
*
* @param requestItems
* A map of one or more table names and, for each table, a map that describes one or more items to retrieve
* from that table. Each table name can be used only once per BatchGetItem request.
*
* Each element in the map of items to retrieve consists of the following:
*
*
* -
*
* ConsistentRead - If true, a strongly consistent read is used; if
* false (the default), an eventually consistent read is used.
*
*
* -
*
* ExpressionAttributeNames - One or more substitution tokens for attribute names in the
* ProjectionExpression parameter. 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 about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* Keys - An array of primary key attribute values that define specific items in 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 value. For a composite key, you must provide both
* the partition key value and the sort key value.
*
*
* -
*
* 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 are returned. If any of the requested attributes
* are not found, they do not appear in the result.
*
*
* For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead.
* For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
*
*
*/
public void setRequestItems(java.util.Map requestItems) {
this.requestItems = requestItems;
}
/**
*
* A map of one or more table names and, for each table, a map that describes one or more items to retrieve from
* that table. Each table name can be used only once per BatchGetItem request.
*
*
* Each element in the map of items to retrieve consists of the following:
*
*
* -
*
* ConsistentRead - If true, a strongly consistent read is used; if false
* (the default), an eventually consistent read is used.
*
*
* -
*
* ExpressionAttributeNames - One or more substitution tokens for attribute names in the
* ProjectionExpression parameter. 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 about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* Keys - An array of primary key attribute values that define specific items in 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 value. For a composite key, you must provide both the partition key
* value and the sort key value.
*
*
* -
*
* 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 are returned. If any of the requested attributes are not
* found, they do not appear in the result.
*
*
* For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For
* more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
*
*
*
*
* @param requestItems
* A map of one or more table names and, for each table, a map that describes one or more items to retrieve
* from that table. Each table name can be used only once per BatchGetItem request.
*
* Each element in the map of items to retrieve consists of the following:
*
*
* -
*
* ConsistentRead - If true, a strongly consistent read is used; if
* false (the default), an eventually consistent read is used.
*
*
* -
*
* ExpressionAttributeNames - One or more substitution tokens for attribute names in the
* ProjectionExpression parameter. 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 about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* Keys - An array of primary key attribute values that define specific items in 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 value. For a composite key, you must provide both
* the partition key value and the sort key value.
*
*
* -
*
* 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 are returned. If any of the requested attributes
* are not found, they do not appear in the result.
*
*
* For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
*
*
* -
*
* AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead.
* For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchGetItemRequest withRequestItems(java.util.Map requestItems) {
setRequestItems(requestItems);
return this;
}
/**
* Add a single RequestItems entry
*
* @see BatchGetItemRequest#withRequestItems
* @returns a reference to this object so that method calls can be chained together.
*/
public BatchGetItemRequest addRequestItemsEntry(String key, KeysAndAttributes value) {
if (null == this.requestItems) {
this.requestItems = new java.util.HashMap();
}
if (this.requestItems.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.requestItems.put(key, value);
return this;
}
/**
* Removes all the entries added into RequestItems.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchGetItemRequest clearRequestItemsEntries() {
this.requestItems = null;
return this;
}
/**
* @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 BatchGetItemRequest 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 BatchGetItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) {
this.returnConsumedCapacity = returnConsumedCapacity.toString();
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 (getRequestItems() != null)
sb.append("RequestItems: ").append(getRequestItems()).append(",");
if (getReturnConsumedCapacity() != null)
sb.append("ReturnConsumedCapacity: ").append(getReturnConsumedCapacity());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof BatchGetItemRequest == false)
return false;
BatchGetItemRequest other = (BatchGetItemRequest) obj;
if (other.getRequestItems() == null ^ this.getRequestItems() == null)
return false;
if (other.getRequestItems() != null && other.getRequestItems().equals(this.getRequestItems()) == false)
return false;
if (other.getReturnConsumedCapacity() == null ^ this.getReturnConsumedCapacity() == null)
return false;
if (other.getReturnConsumedCapacity() != null && other.getReturnConsumedCapacity().equals(this.getReturnConsumedCapacity()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getRequestItems() == null) ? 0 : getRequestItems().hashCode());
hashCode = prime * hashCode + ((getReturnConsumedCapacity() == null) ? 0 : getReturnConsumedCapacity().hashCode());
return hashCode;
}
@Override
public BatchGetItemRequest clone() {
return (BatchGetItemRequest) super.clone();
}
}