Java tutorial
/* * Copyright 2011-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.datamodeling; import java.util.HashMap; import java.util.Map; import com.amazonaws.services.dynamodbv2.model.AttributeValue; import com.amazonaws.services.dynamodbv2.model.Condition; import com.amazonaws.services.dynamodbv2.model.ConditionalOperator; import com.amazonaws.services.dynamodbv2.model.QueryRequest; import com.amazonaws.services.dynamodbv2.model.ReturnConsumedCapacity; import com.amazonaws.services.dynamodbv2.model.Select; /** * A query expression. */ public class DynamoDBQueryExpression<T> { private boolean consistentRead = true; private boolean scanIndexForward = true; private T hashKeyValues; private Map<String, Condition> rangeKeyConditions; private Map<String, AttributeValue> exclusiveStartKey; private Integer limit; private String indexName; private Map<String, Condition> queryFilter; private String conditionalOperator; /** * Evaluates the query results and returns only the desired values. * <p> * The condition you specify is applied to the items queried; any items that * do not match the expression are not returned. */ private String filterExpression; /** * The condition that specifies the key value(s) for items to be retrieved * by the <i>Query</i> action. */ private String keyConditionExpression; /** * One or more substitution variables for simplifying complex expressions. */ private Map<String, String> expressionAttributeNames; /** * One or more values that can be substituted in an expression. */ private Map<String, AttributeValue> expressionAttributeValues; /** * The attributes to be returned in the result. You can retrieve all item * attributes, specific item attributes, the count of matching items, or * in the case of an index, some or all of the attributes projected into * the index. <ul> <li> <p><code>ALL_ATTRIBUTES</code> - Returns all of * the item attributes from the specified table or index. If you query a * local secondary index, then for each matching item in the index * DynamoDB will fetch the entire item from the parent table. If the * index is configured to project all item attributes, then all of the * data can be obtained from the local secondary index, and no fetching * is required. </li> <li> <p><code>ALL_PROJECTED_ATTRIBUTES</code> - * Allowed only when querying an index. Retrieves all attributes that * have been projected into the index. If the index is configured to * project all attributes, this return value is equivalent to specifying * <code>ALL_ATTRIBUTES</code>. </li> <li> <p><code>COUNT</code> - * Returns the number of matching items, rather than the matching items * themselves. </li> <li> <p> <code>SPECIFIC_ATTRIBUTES</code> - Returns * only the attributes listed in <i>AttributesToGet</i>. This return * value is equivalent to specifying <i>AttributesToGet</i> without * specifying any value for <i>Select</i>. <p>If you query a local * secondary index and request only attributes that are projected into * that index, the operation will read only the index and not the table. * If any of the requested attributes are not projected into the local * secondary index, DynamoDB will fetch each of these attributes from the * parent table. This extra fetching incurs additional throughput cost * and latency. <p>If you query a global secondary index, you can only * request attributes that are projected into the index. Global secondary * index queries cannot fetch attributes from the parent table. </li> * </ul> <p>If neither <i>Select</i> nor <i>AttributesToGet</i> are * specified, DynamoDB defaults to <code>ALL_ATTRIBUTES</code> when * accessing a table, and <code>ALL_PROJECTED_ATTRIBUTES</code> when * accessing an index. You cannot use both <i>Select</i> and * <i>AttributesToGet</i> together in a single request, unless the value * for <i>Select</i> is <code>SPECIFIC_ATTRIBUTES</code>. (This usage is * equivalent to specifying <i>AttributesToGet</i> without any value for * <i>Select</i>.) * <p> * <b>Constraints:</b><br/> * <b>Allowed Values: </b>ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT */ private String select; /** * 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>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. <p>For more information, go to <a * href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing * Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. */ private String projectionExpression; /** * A value that if set to <code>TOTAL</code>, the response includes * <i>ConsumedCapacity</i> data for tables and indexes. If set to * <code>INDEXES</code>, the response includes <i>ConsumedCapacity</i> * for indexes. If set to <code>NONE</code> (the default), * <i>ConsumedCapacity</i> is not included in the response. * <p> * <b>Constraints:</b><br/> * <b>Allowed Values: </b>INDEXES, TOTAL, NONE * <p> * If enabled, the underlying request to DynamoDB will include the * configured parameter value and the low-level response from DynamoDB will * include the amount of capacity consumed by the query. Currently, the * consumed capacity is only exposed through the DynamoDBMapper when you * call {@code DynamoDBMapper.queryPage}, not {@code DynamoDBMapper.query}. */ private String returnConsumedCapacity; /** * Returns whether this query uses consistent reads. */ public boolean isConsistentRead() { return consistentRead; } /** * Sets whether this query uses consistent reads. */ public void setConsistentRead(boolean consistentRead) { this.consistentRead = consistentRead; } /** * Sets whether this query uses consistent reads and returns a pointer to * this object for method-chaining. */ public DynamoDBQueryExpression<T> withConsistentRead(boolean consistentRead) { this.consistentRead = consistentRead; return this; } /** * Returns whether this query scans forward. */ public boolean isScanIndexForward() { return scanIndexForward; } /** * Sets whether this query scans forward. */ public void setScanIndexForward(boolean scanIndexForward) { this.scanIndexForward = scanIndexForward; } /** * Sets whether this query scans forward and returns a pointer to this * object for method-chaining. */ public DynamoDBQueryExpression<T> withScanIndexForward(boolean scanIndexForward) { this.scanIndexForward = scanIndexForward; return this; } /** * Returns the exclusive start key for this query. */ public Map<String, AttributeValue> getExclusiveStartKey() { return exclusiveStartKey; } /** * Sets the exclusive start key for this query. */ public void setExclusiveStartKey(Map<String, AttributeValue> exclusiveStartKey) { this.exclusiveStartKey = exclusiveStartKey; } /** * Sets the exclusive start key for this query and returns a pointer to this * object for method-chaining. */ public DynamoDBQueryExpression<T> withExclusiveStartKey(Map<String, AttributeValue> exclusiveStartKey) { this.exclusiveStartKey = exclusiveStartKey; return this; } /** * Returns the maximum number of items to retrieve in each service request * to DynamoDB. * <p> * Note that when calling {@code DynamoDBMapper.query}, multiple requests * are made to DynamoDB if needed to retrieve the entire result set. Setting * this will limit the number of items retrieved by each request, NOT * the total number of results that will be retrieved. Use * {@code DynamoDBMapper.queryPage} to retrieve a single page of items from * DynamoDB. */ public Integer getLimit() { return limit; } /** * Sets the maximum number of items to retrieve in each service request to * DynamoDB. * <p> * Note that when calling {@code DynamoDBMapper.query}, multiple requests * are made to DynamoDB if needed to retrieve the entire result set. Setting * this will limit the number of items retrieved by each request, NOT * the total number of results that will be retrieved. Use * {@code DynamoDBMapper.queryPage} to retrieve a single page of items from * DynamoDB. */ public void setLimit(Integer limit) { this.limit = limit; } /** * Sets the maximum number of items to retrieve in each service request to * DynamoDB and returns a pointer to this object for method-chaining. * <p> * Note that when calling {@code DynamoDBMapper.query}, multiple requests * are made to DynamoDB if needed to retrieve the entire result set. Setting * this will limit the number of items retrieved by each request, NOT * the total number of results that will be retrieved. Use * {@code DynamoDBMapper.queryPage} to retrieve a single page of items from * DynamoDB. */ public DynamoDBQueryExpression<T> withLimit(Integer limit) { this.limit = limit; return this; } /** * Gets the hash key value(s) for this query. All hash key attributes for * the table must be specified with this key object. */ public T getHashKeyValues() { return hashKeyValues; } /** * Sets the hash key value(s) for this query. All hash key attributes for * the table must be specified with this key object. * * Note 1: Currently the DynamoDBMapper supports only one value per hash key. * Note 2: Currently the Amazon DynamoDB supports only one hash key per * table/index. */ public void setHashKeyValues(T hashKeyValues) { this.hashKeyValues = hashKeyValues; } /** * Sets the hash key value(s) for this query. All hash key attributes for * the table must be specified with this key object. */ public DynamoDBQueryExpression<T> withHashKeyValues(T hashKObject) { setHashKeyValues(hashKObject); return this; } /** * Gets the range key condition for this query. All range key attributes for * the table must be specified by attribute name in the map. */ public Map<String, Condition> getRangeKeyConditions() { return rangeKeyConditions; } /** * Sets the range key condition for this query. All range key attributes for * the table must be specified by attribute name in the map. * * @param rangeKeyConditions a map from key name to condition * NOTE: The current DynamoDB service only allows up to one * range key condition per query. Providing more than one * range key condition will result in a SdkClientException. */ public void setRangeKeyConditions(Map<String, Condition> rangeKeyConditions) { this.rangeKeyConditions = rangeKeyConditions; } /** * Sets the range key condition for this query. All range key attributes for * the table must be specified by attribute name in the map. * * @param rangeKeyConditions a map from key name to condition * NOTE: The current DynamoDB service only allows up to one range * key condition per query. Providing more than one range key * condition will result in a SdkClientException. */ public DynamoDBQueryExpression<T> withRangeKeyConditions(Map<String, Condition> rangeKeyConditions) { setRangeKeyConditions(rangeKeyConditions); return this; } /** * Sets one range key condition for this query, using the attribute name of * the range key. All range key attributes for the table must be specified * by using {@link DynamoDBRangeKey} or {@link DynamoDBIndexRangeKey} annotations * before executing the query. * <dl> * <dt>If the attribute is the primary range key</dt> * <dd>users should NOT set any index name for this query.</dd> * <dt>If the attribute is an index range key</dt> * <dd> * {@link DynamoDBMapper} will automatically set the index name if the * range key is annotated as only used by one local secondary index, * otherwise users must set the index name manually by either * {@link DynamoDBQueryExpression#setIndexName(String)} or * {@link DynamoDBQueryExpression#withIndexName(String)}. * </dd> * </dl> * * @param rangeKeyAttributeName * This can be either the primary range key of the table or an * index range key. * * @param rangeKeyCondition * Condition specified on the given range key for this query. */ public DynamoDBQueryExpression<T> withRangeKeyCondition(String rangeKeyAttributeName, Condition rangeKeyCondition) { if (rangeKeyConditions == null) rangeKeyConditions = new HashMap<String, Condition>(); rangeKeyConditions.put(rangeKeyAttributeName, rangeKeyCondition); return this; } /** * Returns the name of the index to be used by this query. */ public String getIndexName() { return indexName; } /** * Sets the name of the index to be used by this query. The hash key * and/or range key of the index must be specified by adding * {@link DynamoDBIndexHashKey} or {@code DynamoDBIndexRangeKey} * annotations to the appropriate getter methods of the mapped * object. */ public void setIndexName(String indexName) { this.indexName = indexName; } /** * Sets the name of the index to be used by this query. The hash key * and/or range key of the index must be specified by adding * {@link DynamoDBIndexHashKey} or {@code DynamoDBIndexRangeKey} * annotations to the appropriate getter methods of the mapped * object. * <p> * Returns a pointer to this object for method-chaining. */ public DynamoDBQueryExpression<T> withIndexName(String indexName) { setIndexName(indexName); return this; } /** * Returns the query filter applied on this query. */ public Map<String, Condition> getQueryFilter() { return queryFilter; } /** * Sets the query filter applied on this query. */ public void setQueryFilter(Map<String, Condition> queryFilter) { this.queryFilter = queryFilter; } /** * Sets the query filter applied on this query. * <p>Returns a pointer to this object for method-chaining. */ public DynamoDBQueryExpression<T> withQueryFilter(Map<String, Condition> queryFilter) { setQueryFilter(queryFilter); return this; } /** * Adds a new condition to the the query filter. * <p>Returns a pointer to this object for method-chaining. * * @param attributeName * The name of the attribute on which the specified condition * operates. * @param condition * The filter condition applied on the attribute. */ public DynamoDBQueryExpression<T> withQueryFilterEntry(String attributeName, Condition condition) { if (queryFilter == null) { queryFilter = new HashMap<String, Condition>(); } queryFilter.put(attributeName, condition); return this; } /** * Returns the logical operator on the query filter conditions. */ public String getConditionalOperator() { return conditionalOperator; } /** * Sets the logical operator on the query filter conditions. */ public void setConditionalOperator(String conditionalOperator) { this.conditionalOperator = conditionalOperator; } /** * Sets the logical operator on the query filter conditions. * <p>Returns a pointer to this object for method-chaining. */ public DynamoDBQueryExpression<T> withConditionalOperator(String conditionalOperator) { setConditionalOperator(conditionalOperator); return this; } /** * Sets the logical operator on the query filter conditions. */ public void setConditionalOperator(ConditionalOperator conditionalOperator) { this.conditionalOperator = conditionalOperator.toString(); } /** * Sets the logical operator on the query filter conditions. * <p>Returns a pointer to this object for method-chaining. */ public DynamoDBQueryExpression<T> withConditionalOperator(ConditionalOperator conditionalOperator) { setConditionalOperator(conditionalOperator); return this; } /** * Evaluates the query results and returns only the desired values. * <p> * The condition you specify is applied to the items queried; any items that * do not match the expression are not returned. * * @return Evaluates the query results and returns only the desired values. * <p> * The condition you specify is applied to the items queried; any * items that do not match the expression are not returned. * @see QueryRequest#getFilterExpression() */ public String getFilterExpression() { return filterExpression; } /** * Evaluates the query results and returns only the desired values. * <p> * The condition you specify is applied to the items queried; any items that * do not match the expression are not returned. * * @param filterExpression * Evaluates the query results and returns only the desired * values. * <p> * The condition you specify is applied to the items queried; any * items that do not match the expression are not returned. * @see QueryRequest#setFilterExpression(String) */ public void setFilterExpression(String filterExpression) { this.filterExpression = filterExpression; } /** * Evaluates the query results and returns only the desired values. * <p> * The condition you specify is applied to the items queried; any items that * do not match the expression are not returned. * <p> * Returns a reference to this object so that method calls can be chained * together. * * @param filterExpression * Evaluates the query results and returns only the desired * values. * <p> * The condition you specify is applied to the items queried; any * items that do not match the expression are not returned. * * @return A reference to this updated object so that method calls can be * chained together. * @see QueryRequest#withFilterExpression(String) */ public DynamoDBQueryExpression<T> withFilterExpression(String filterExpression) { this.filterExpression = filterExpression; return this; } /** * Returns the condition that specifies the key value(s) for items to be * retrieved by the <i>Query</i> action. * <p> * The condition must perform an equality test on a single hash key value. * The condition can also test for one or more range key values. A * <i>Query</i> can use <i>KeyConditionExpression</i> to retrieve a single * item with a given hash and range key value, or several items that have * the same hash key value but different range key values. * <p> * The hash key equality test is required, and must be specified in the * following format: * <p> * <code>hashAttributeName</code> <i>=</i> <code>:hashval</code> * <p> * If you also want to provide a range key condition, it must be combined * using <i>AND</i> with the hash key condition. Following is an example, * using the <b>=</b> comparison operator for the range key: * <p> * <code>hashAttributeName</code> <i>=</i> <code>:hashval</code> <i>AND</i> * <code>rangeAttributeName</code> <i>=</i> <code>:rangeval</code> * <p> * Valid comparisons for the range key condition are as follows: * <ul> * <li> * <p> * <code>rangeAttributeName</code> <i>=</i> <code>:rangeval</code> - true if * the range key is equal to <code>:rangeval</code>.</li> * <li> * <p> * <code>rangeAttributeName</code> <i><</i> <code>:rangeval</code> - true if * the range key is less than <code>:rangeval</code>.</li> * <li> * <p> * <code>rangeAttributeName</code> <i><=</i> <code>:rangeval</code> - true * if the range key is less than or equal to <code>:rangeval</code>.</li> * <li> * <p> * <code>rangeAttributeName</code> <i>></i> <code>:rangeval</code> - true if * the range key is greater than <code>:rangeval</code>.</li> * <li> * <p> * <code>rangeAttributeName</code> <i>>=</i><code>:rangeval</code> - true * if the range key is greater than or equal to <code>:rangeval</code>.</li> * <li> * <p> * <code>rangeAttributeName</code> <i>BETWEEN</i> <code>:rangeval1</code> * <i>AND</i> <code>:rangeval2</code> - true if the range key is greater * than or equal to <code>:rangeval1</code>, and less than or equal to * <code>:rangeval2</code>.</li> * <li> * <p> * <i>begins_with (</i><code>rangeAttributeName</code>, * <code>:rangeval</code><i>)</i> - true if the range key begins with a * particular operand. Note that the function name <code>begins_with</code> * is case-sensitive.</li> * </ul> * <p> * Use <i>ExpressionAttributeValues</i> (via {@link #withExpressionAttributeValues(Map)}) to * replace tokens such as <code>:hashval</code> and <code>:rangeval</code> * with actual values at runtime. * <p> * You can optionally use <i>ExpressionAttributeNames</i> (via * {@link #withExpressionAttributeNames(Map)}) to replace the names of the hash and range * attributes with placeholder tokens. This might be necessary if an * attribute name conflicts with a DynamoDB reserved word. For example, the * following <i>KeyConditionExpression</i> causes an error because * <i>Size</i> is a reserved word: * <ul> * <li> <code>Size = :myval</code></li> * </ul> * <p> * To work around this, define a placeholder (such a <code>#myval</code>) to * represent the attribute name <i>Size</i>. <i>KeyConditionExpression</i> * then is as follows: * <ul> * <li> <code>#S = * :myval</code></li> * </ul> * <p> * For a list of reserved words, see <a href= * "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html" * >Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>. * <p> * For more information on <i>ExpressionAttributeNames</i> and * <i>ExpressionAttributeValues</i>, see <a href= * "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ExpressionPlaceholders.html" * >Using Placeholders for Attribute Names and Values</a> in the <i>Amazon * DynamoDB Developer Guide</i>. <note> * <p> * <i>KeyConditionExpression</i> replaces the legacy <i>KeyConditions</i> * parameter. </note> * * @return The condition that specifies the key value(s) for items to be * retrieved by the <i>Query</i> action. * <p> * The condition must perform an equality test on a single hash key * value. The condition can also test for one or more range key * values. A <i>Query</i> can use <i>KeyConditionExpression</i> to * retrieve a single item with a given hash and range key value, or * several items that have the same hash key value but different * range key values. * <p> * The hash key equality test is required, and must be specified in * the following format: * <p> * <code>hashAttributeName</code> <i>=</i> <code>:hashval</code> * <p> * If you also want to provide a range key condition, it must be * combined using <i>AND</i> with the hash key condition. Following * is an example, using the <b>=</b> comparison operator for the * range key: * <p> * <code>hashAttributeName</code> <i>=</i> <code>:hashval</code> * <i>AND</i> <code>rangeAttributeName</code> <i>=</i> * <code>:rangeval</code> * <p> * Valid comparisons for the range key condition are as follows: * <ul> * <li> * <p> * <code>rangeAttributeName</code> <i>=</i> <code>:rangeval</code> - * true if the range key is equal to <code>:rangeval</code>.</li> * <li> * <p> * <code>rangeAttributeName</code> <i><</i> <code>:rangeval</code> - * true if the range key is less than <code>:rangeval</code>.</li> * <li> * <p> * <code>rangeAttributeName</code> <i><=</i> <code>:rangeval</code> * - true if the range key is less than or equal to * <code>:rangeval</code>.</li> * <li> * <p> * <code>rangeAttributeName</code> <i>></i> <code>:rangeval</code> - * true if the range key is greater than <code>:rangeval</code>.</li> * <li> * <p> * <code>rangeAttributeName</code> <i>>= </i><code>:rangeval</code> * - true if the range key is greater than or equal to * <code>:rangeval</code>.</li> * <li> * <p> * <code>rangeAttributeName</code> <i>BETWEEN</i> * <code>:rangeval1</code> <i>AND</i> <code>:rangeval2</code> - true * if the range key is greater than or equal to * <code>:rangeval1</code>, and less than or equal to * <code>:rangeval2</code>.</li> * <li> * <p> * <i>begins_with (</i><code>rangeAttributeName</code>, * <code>:rangeval</code><i>)</i> - true if the range key begins * with a particular operand. Note that the function name * <code>begins_with</code> is case-sensitive.</li> * </ul> * <p> * Use <i>ExpressionAttributeValues</i> (via * {@link #withExpressionAttributeValues(Map)}) to replace tokens such as * <code>:hashval</code> and <code>:rangeval</code> with actual * values at runtime. * <p> * You can optionally use <i>ExpressionAttributeNames</i> (via * {@link #withExpressionAttributeNames(Map)}) to replace the names of the hash and * range attributes with placeholder tokens. This might be necessary * if an attribute name conflicts with a DynamoDB reserved word. For * example, the following <i>KeyConditionExpression</i> causes an * error because <i>Size</i> is a reserved word: * <ul> * <li> <code>Size = :myval</code></li> * </ul> * <p> * To work around this, define a placeholder (such a * <code>#myval</code>) to represent the attribute name <i>Size</i>. * <i>KeyConditionExpression</i> then is as follows: * <ul> * <li> <code>#S = * :myval</code></li> * </ul> * <p> * For a list of reserved words, see <a href= * "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html" * >Reserved Words</a> in the <i>Amazon DynamoDB Developer * Guide</i>. * <p> * For more information on <i>ExpressionAttributeNames</i> and * <i>ExpressionAttributeValues</i>, see <a href= * "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ExpressionPlaceholders.html" * >Using Placeholders for Attribute Names and Values</a> in the * <i>Amazon DynamoDB Developer Guide</i>. <note> * <p> * <i>KeyConditionExpression</i> replaces the legacy * <i>KeyConditions</i> parameter. </note> */ public String getKeyConditionExpression() { return keyConditionExpression; } /** * Sets the condition that specifies the key value(s) for items to be * retrieved by the <i>Query</i> action. * <p> * The condition must perform an equality test on a single hash key value. * The condition can also test for one or more range key values. A * <i>Query</i> can use <i>KeyConditionExpression</i> to retrieve a single * item with a given hash and range key value, or several items that have * the same hash key value but different range key values. * <p> * The hash key equality test is required, and must be specified in the * following format: * <p> * <code>hashAttributeName</code> <i>=</i> <code>:hashval</code> * <p> * If you also want to provide a range key condition, it must be combined * using <i>AND</i> with the hash key condition. Following is an example, * using the <b>=</b> comparison operator for the range key: * <p> * <code>hashAttributeName</code> <i>=</i> <code>:hashval</code> <i>AND</i> * <code>rangeAttributeName</code> <i>=</i> <code>:rangeval</code> * <p> * Valid comparisons for the range key condition are as follows: * <ul> * <li> * <p> * <code>rangeAttributeName</code> <i>=</i> <code>:rangeval</code> - true if * the range key is equal to <code>:rangeval</code>.</li> * <li> * <p> * <code>rangeAttributeName</code> <i><</i> <code>:rangeval</code> - true if * the range key is less than <code>:rangeval</code>.</li> * <li> * <p> * <code>rangeAttributeName</code> <i><=</i> <code>:rangeval</code> - true * if the range key is less than or equal to <code>:rangeval</code>.</li> * <li> * <p> * <code>rangeAttributeName</code> <i>></i> <code>:rangeval</code> - true if * the range key is greater than <code>:rangeval</code>.</li> * <li> * <p> * <code>rangeAttributeName</code> <i>>= </i><code>:rangeval</code> - true * if the range key is greater than or equal to <code>:rangeval</code>.</li> * <li> * <p> * <code>rangeAttributeName</code> <i>BETWEEN</i> <code>:rangeval1</code> * <i>AND</i> <code>:rangeval2</code> - true if the range key is greater * than or equal to <code>:rangeval1</code>, and less than or equal to * <code>:rangeval2</code>.</li> * <li> * <p> * <i>begins_with (</i><code>rangeAttributeName</code>, * <code>:rangeval</code><i>)</i> - true if the range key begins with a * particular operand. Note that the function name <code>begins_with</code> * is case-sensitive.</li> * </ul> * <p> * Use <i>ExpressionAttributeValues</i> (via {@link #withExpressionAttributeValues(Map)}) to * replace tokens such as <code>:hashval</code> and <code>:rangeval</code> * with actual values at runtime. * <p> * You can optionally use <i>ExpressionAttributeNames</i> via * {@link #withExpressionAttributeNames(Map)}) to replace the names of the hash and range * attributes with placeholder tokens. This might be necessary if an * attribute name conflicts with a DynamoDB reserved word. For example, the * following <i>KeyConditionExpression</i> causes an error because * <i>Size</i> is a reserved word: * <ul> * <li> <code>Size = :myval</code></li> * </ul> * <p> * To work around this, define a placeholder (such a <code>#myval</code>) to * represent the attribute name <i>Size</i>. <i>KeyConditionExpression</i> * then is as follows: * <ul> * <li> <code>#S = * :myval</code></li> * </ul> * <p> * For a list of reserved words, see <a href= * "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html" * >Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>. * <p> * For more information on <i>ExpressionAttributeNames</i> and * <i>ExpressionAttributeValues</i>, see <a href= * "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ExpressionPlaceholders.html" * >Using Placeholders for Attribute Names and Values</a> in the <i>Amazon * DynamoDB Developer Guide</i>. <note> * <p> * <i>KeyConditionExpression</i> replaces the legacy <i>KeyConditions</i> * parameter. </note> * <p> * When a key expression is specified, the corresponding name-map and * value-map can optionally be specified via {@link #withExpressionAttributeNames(Map)} and * {@link #withExpressionAttributeValues(Map)}. */ public void setKeyConditionExpression(String keyConditionExpression) { this.keyConditionExpression = keyConditionExpression; } public DynamoDBQueryExpression<T> withKeyConditionExpression(String keyConditionExpression) { this.keyConditionExpression = keyConditionExpression; return this; } /** * One or more substitution variables for simplifying complex expressions. * * @return One or more substitution variables for simplifying complex * expressions. * @see QueryRequest#getExpressionAttributeNames() */ public java.util.Map<String, String> getExpressionAttributeNames() { return expressionAttributeNames; } /** * One or more substitution variables for simplifying complex expressions. * * @param expressionAttributeNames * One or more substitution variables for simplifying complex * expressions. * @see QueryRequest#setExpressionAttributeNames(Map) */ public void setExpressionAttributeNames(java.util.Map<String, String> expressionAttributeNames) { this.expressionAttributeNames = expressionAttributeNames; } /** * One or more substitution variables for simplifying complex expressions. * * @param expressionAttributeNames * One or more substitution variables for simplifying complex * expressions. * * @return A reference to this updated object so that method calls can be * chained together. * @see QueryRequest#withExpressionAttributeNames(Map) */ public DynamoDBQueryExpression<T> withExpressionAttributeNames( java.util.Map<String, String> expressionAttributeNames) { setExpressionAttributeNames(expressionAttributeNames); return this; } /** * One or more substitution variables for simplifying complex expressions. * 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. * * @see QueryRequest#addExpressionAttributeNamesEntry(String, String) */ public DynamoDBQueryExpression<T> 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. * <p> * Returns a reference to this object so that method calls can be chained * together. */ public DynamoDBQueryExpression<T> clearExpressionAttributeNamesEntries() { this.expressionAttributeNames = null; return this; } /** * One or more values that can be substituted in an expression. * * @return One or more values that can be substituted in an expression. * * @see QueryRequest#getExpressionAttributeValues() */ public java.util.Map<String, AttributeValue> getExpressionAttributeValues() { return expressionAttributeValues; } /** * One or more values that can be substituted in an expression. * * @param expressionAttributeValues * One or more values that can be substituted in an expression. * * @see QueryRequest#setExpressionAttributeValues(Map) */ public void setExpressionAttributeValues(java.util.Map<String, AttributeValue> expressionAttributeValues) { this.expressionAttributeValues = expressionAttributeValues; } /** * One or more values that can be substituted in an expression. * * @param expressionAttributeValues * One or more values that can be substituted in an expression. * * @return A reference to this updated object so that method calls can be * chained together. * @see QueryRequest#withExpressionAttributeValues(Map) */ public DynamoDBQueryExpression<T> withExpressionAttributeValues( java.util.Map<String, AttributeValue> expressionAttributeValues) { setExpressionAttributeValues(expressionAttributeValues); return this; } /** * One or more values that can be substituted in an expression. The method * adds a new key-value pair into ExpressionAttributeValues 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 * ExpressionAttributeValues. * @param value * The corresponding value of the entry to be added into * ExpressionAttributeValues. * * @see QueryRequest#addExpressionAttributeValuesEntry(String, * AttributeValue) */ public DynamoDBQueryExpression<T> addExpressionAttributeValuesEntry(String key, AttributeValue value) { if (null == this.expressionAttributeValues) { this.expressionAttributeValues = new java.util.HashMap<String, AttributeValue>(); } if (this.expressionAttributeValues.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.expressionAttributeValues.put(key, value); return this; } /** * Removes all the entries added into ExpressionAttributeValues. * <p> * Returns a reference to this object so that method calls can be chained * together. */ public DynamoDBQueryExpression<T> clearExpressionAttributeValuesEntries() { this.expressionAttributeValues = null; return this; } /** * The attributes to be returned in the result. You can retrieve all item * attributes, specific item attributes, the count of matching items, or * in the case of an index, some or all of the attributes projected into * the index. * <p> * <b>Constraints:</b><br/> * <b>Allowed Values: </b>ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT * * @return The attributes to be returned in the result. You can retrieve all item * attributes, specific item attributes, the count of matching items, or * in the case of an index, some or all of the attributes projected into * the index. * * @see com.amazonaws.services.dynamodbv2.model.Select */ public String getSelect() { return select; } /** * The attributes to be returned in the result. You can retrieve all item * attributes, specific item attributes, the count of matching items, or * in the case of an index, some or all of the attributes projected into * the index. * <p> * <b>Constraints:</b><br/> * <b>Allowed Values: </b>ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT * * @param select The attributes to be returned in the result. You can retrieve all item * attributes, specific item attributes, the count of matching items, or * in the case of an index, some or all of the attributes projected into * the index. * * @see com.amazonaws.services.dynamodbv2.model.Select */ public void setSelect(String select) { this.select = select; } /** * The attributes to be returned in the result. You can retrieve all item * attributes, specific item attributes, the count of matching items, or * in the case of an index, some or all of the attributes projected into * the index. * <p> * Returns a reference to this object so that method calls can be chained together. * <p> * <b>Constraints:</b><br/> * <b>Allowed Values: </b>ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT * * @param select The attributes to be returned in the result. You can retrieve all item * attributes, specific item attributes, the count of matching items, or * in the case of an index, some or all of the attributes projected into * the index. * * @return A reference to this updated object so that method calls can be chained * together. * * @see com.amazonaws.services.dynamodbv2.model.Select */ public DynamoDBQueryExpression<T> withSelect(String select) { this.select = select; return this; } /** * The attributes to be returned in the result. You can retrieve all item * attributes, specific item attributes, the count of matching items, or * in the case of an index, some or all of the attributes projected into * the index. * <p> * <b>Constraints:</b><br/> * <b>Allowed Values: </b>ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT * * @param select The attributes to be returned in the result. You can retrieve all item * attributes, specific item attributes, the count of matching items, or * in the case of an index, some or all of the attributes projected into * the index. * * @see com.amazonaws.services.dynamodbv2.model.Select */ public void setSelect(Select select) { this.select = select.toString(); } /** * The attributes to be returned in the result. You can retrieve all item * attributes, specific item attributes, the count of matching items, or * in the case of an index, some or all of the attributes projected into * the index. * <p> * Returns a reference to this object so that method calls can be chained together. * <p> * <b>Constraints:</b><br/> * <b>Allowed Values: </b>ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT * * @param select The attributes to be returned in the result. You can retrieve all item * attributes, specific item attributes, the count of matching items, or * in the case of an index, some or all of the attributes projected into * the index. * * @return A reference to this updated object so that method calls can be chained * together. * * @see com.amazonaws.services.dynamodbv2.model.Select */ public DynamoDBQueryExpression<T> withSelect(Select select) { this.select = select.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. <p>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. <p>For more information, go to <a * href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing * Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. * * @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>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. <p>For more information, go to <a * href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing * Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. */ 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. <p>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. <p>For more information, go to <a * href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing * Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. * * @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>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. <p>For more information, go to <a * href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing * Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. */ 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. <p>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. <p>For more information, go to <a * href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing * Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. * <p> * 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. <p>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. <p>For more information, go to <a * href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing * Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. * * @return A reference to this updated object so that method calls can be chained * together. */ public DynamoDBQueryExpression<T> withProjectionExpression(String projectionExpression) { this.projectionExpression = projectionExpression; return this; } /** * A value that if set to <code>TOTAL</code>, the response includes * <i>ConsumedCapacity</i> data for tables and indexes. If set to * <code>INDEXES</code>, the response includes <i>ConsumedCapacity</i> * for indexes. If set to <code>NONE</code> (the default), * <i>ConsumedCapacity</i> is not included in the response. * <p> * <b>Constraints:</b><br/> * <b>Allowed Values: </b>INDEXES, TOTAL, NONE * <p> * If enabled, the underlying request to DynamoDB will include the * configured parameter value and the low-level response from DynamoDB will * include the amount of capacity consumed by the query. Currently, the * consumed capacity is only exposed through the DynamoDBMapper when you * call {@code DynamoDBMapper.queryPage}, not {@code DynamoDBMapper.query}. * * @return A value that if set to <code>TOTAL</code>, the response includes * <i>ConsumedCapacity</i> data for tables and indexes. If set to * <code>INDEXES</code>, the response includes <i>ConsumedCapacity</i> * for indexes. If set to <code>NONE</code> (the default), * <i>ConsumedCapacity</i> is not included in the response. * * @see com.amazonaws.services.dynamodbv2.model.ReturnConsumedCapacity */ public String getReturnConsumedCapacity() { return returnConsumedCapacity; } /** * A value that if set to <code>TOTAL</code>, the response includes * <i>ConsumedCapacity</i> data for tables and indexes. If set to * <code>INDEXES</code>, the response includes <i>ConsumedCapacity</i> * for indexes. If set to <code>NONE</code> (the default), * <i>ConsumedCapacity</i> is not included in the response. * <p> * <b>Constraints:</b><br/> * <b>Allowed Values: </b>INDEXES, TOTAL, NONE * <p> * If enabled, the underlying request to DynamoDB will include the * configured parameter value and the low-level response from DynamoDB will * include the amount of capacity consumed by the query. Currently, the * consumed capacity is only exposed through the DynamoDBMapper when you * call {@code DynamoDBMapper.queryPage}, not {@code DynamoDBMapper.query}. * * @param returnConsumedCapacity A value that if set to <code>TOTAL</code>, the response includes * <i>ConsumedCapacity</i> data for tables and indexes. If set to * <code>INDEXES</code>, the response includes <i>ConsumedCapacity</i> * for indexes. If set to <code>NONE</code> (the default), * <i>ConsumedCapacity</i> is not included in the response. * * @see com.amazonaws.services.dynamodbv2.model.ReturnConsumedCapacity */ public void setReturnConsumedCapacity(String returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity; } /** * A value that if set to <code>TOTAL</code>, the response includes * <i>ConsumedCapacity</i> data for tables and indexes. If set to * <code>INDEXES</code>, the response includes <i>ConsumedCapacity</i> * for indexes. If set to <code>NONE</code> (the default), * <i>ConsumedCapacity</i> is not included in the response. * <p> * Returns a reference to this object so that method calls can be chained together. * <p> * <b>Constraints:</b><br/> * <b>Allowed Values: </b>INDEXES, TOTAL, NONE * <p> * If enabled, the underlying request to DynamoDB will include the * configured parameter value and the low-level response from DynamoDB will * include the amount of capacity consumed by the query. Currently, the * consumed capacity is only exposed through the DynamoDBMapper when you * call {@code DynamoDBMapper.queryPage}, not {@code DynamoDBMapper.query}. * * @param returnConsumedCapacity A value that if set to <code>TOTAL</code>, the response includes * <i>ConsumedCapacity</i> data for tables and indexes. If set to * <code>INDEXES</code>, the response includes <i>ConsumedCapacity</i> * for indexes. If set to <code>NONE</code> (the default), * <i>ConsumedCapacity</i> is not included in the response. * * @return A reference to this updated object so that method calls can be chained * together. * * @see com.amazonaws.services.dynamodbv2.model.ReturnConsumedCapacity */ public DynamoDBQueryExpression<T> withReturnConsumedCapacity(String returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity; return this; } /** * A value that if set to <code>TOTAL</code>, the response includes * <i>ConsumedCapacity</i> data for tables and indexes. If set to * <code>INDEXES</code>, the response includes <i>ConsumedCapacity</i> * for indexes. If set to <code>NONE</code> (the default), * <i>ConsumedCapacity</i> is not included in the response. * <p> * <b>Constraints:</b><br/> * <b>Allowed Values: </b>INDEXES, TOTAL, NONE * <p> * If enabled, the underlying request to DynamoDB will include the * configured parameter value and the low-level response from DynamoDB will * include the amount of capacity consumed by the query. Currently, the * consumed capacity is only exposed through the DynamoDBMapper when you * call {@code DynamoDBMapper.queryPage}, not {@code DynamoDBMapper.query}. * * @param returnConsumedCapacity A value that if set to <code>TOTAL</code>, the response includes * <i>ConsumedCapacity</i> data for tables and indexes. If set to * <code>INDEXES</code>, the response includes <i>ConsumedCapacity</i> * for indexes. If set to <code>NONE</code> (the default), * <i>ConsumedCapacity</i> is not included in the response. * * @see com.amazonaws.services.dynamodbv2.model.ReturnConsumedCapacity */ public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity.toString(); } /** * A value that if set to <code>TOTAL</code>, the response includes * <i>ConsumedCapacity</i> data for tables and indexes. If set to * <code>INDEXES</code>, the response includes <i>ConsumedCapacity</i> * for indexes. If set to <code>NONE</code> (the default), * <i>ConsumedCapacity</i> is not included in the response. * <p> * Returns a reference to this object so that method calls can be chained together. * <p> * <b>Constraints:</b><br/> * <b>Allowed Values: </b>INDEXES, TOTAL, NONE * <p> * If enabled, the underlying request to DynamoDB will include the * configured parameter value and the low-level response from DynamoDB will * include the amount of capacity consumed by the query. Currently, the * consumed capacity is only exposed through the DynamoDBMapper when you * call {@code DynamoDBMapper.queryPage}, not {@code DynamoDBMapper.query}. * * @param returnConsumedCapacity A value that if set to <code>TOTAL</code>, the response includes * <i>ConsumedCapacity</i> data for tables and indexes. If set to * <code>INDEXES</code>, the response includes <i>ConsumedCapacity</i> * for indexes. If set to <code>NONE</code> (the default), * <i>ConsumedCapacity</i> is not included in the response. * * @return A reference to this updated object so that method calls can be chained * together. * * @see com.amazonaws.services.dynamodbv2.model.ReturnConsumedCapacity */ public DynamoDBQueryExpression<T> withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) { this.returnConsumedCapacity = returnConsumedCapacity.toString(); return this; } }