Package software.amazon.awssdk.services.dynamodb.model

Class BatchGetItemRequest

    • Method Detail

      • hasRequestItems

        public final boolean hasRequestItems()
        For responses, this returns true if the service returned a value for the RequestItems property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • requestItems

        public final Map<String,​KeysAndAttributes> 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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRequestItems() method.

        Returns:
        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.

      • toString

        public final String toString()
        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.
        Overrides:
        toString in class Object