DynamoDBQueryExpression (AWS SDK for Android - Amazon DynamoDB Mapper 2.14.0 API)

java.lang.Object
- com.amazonaws.mobileconnectors.dynamodbv2.dynamodbmapper.DynamoDBQueryExpression<T>

Type Parameters:: T - the hash key value.

public class DynamoDBQueryExpression<T>
extends Object

A query expression.

Constructor Summary

Constructors
Constructor and Description

DynamoDBQueryExpression()

Constructors
Constructor and Description
`DynamoDBQueryExpression()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DynamoDBQueryExpression<T>`	`addExpressionAttributeNamesEntry(String key, String value)` One or more substitution variables for simplifying complex expressions.
`DynamoDBQueryExpression<T>`	`addExpressionAttributeValuesEntry(String key, AttributeValue value)` One or more values that can be substituted in an expression.
`DynamoDBQueryExpression<T>`	`clearExpressionAttributeNamesEntries()` Removes all the entries added into ExpressionAttributeNames.
`DynamoDBQueryExpression<T>`	`clearExpressionAttributeValuesEntries()` Removes all the entries added into ExpressionAttributeValues.
`String`	`getConditionalOperator()` Returns the logical operator on the query filter conditions.
`Map<String,AttributeValue>`	`getExclusiveStartKey()` Returns the exclusive start key for this query.
`Map<String,String>`	`getExpressionAttributeNames()` One or more substitution variables for simplifying complex expressions.
`Map<String,AttributeValue>`	`getExpressionAttributeValues()` One or more values that can be substituted in an expression.
`String`	`getFilterExpression()` Evaluates the query results and returns only the desired values.
`T`	`getHashKeyValues()` Gets the hash key value(s) for this query.
`String`	`getIndexName()` Returns the name of the index to be used by this query.
`Integer`	`getLimit()` Returns the maximum number of items to retrieve in each service request to DynamoDB.
`Map<String,Condition>`	`getQueryFilter()` Returns the query filter applied on this query.
`Map<String,Condition>`	`getRangeKeyConditions()` Gets the range key condition for this query.
`boolean`	`isConsistentRead()` Returns whether this query uses consistent reads.
`boolean`	`isScanIndexForward()` Returns whether this query scans forward.
`void`	`setConditionalOperator(ConditionalOperator conditionalOperator)` Sets the logical operator on the query filter conditions.
`void`	`setConditionalOperator(String conditionalOperator)` Sets the logical operator on the query filter conditions.
`void`	`setConsistentRead(boolean consistentRead)` Sets whether this query uses consistent reads.
`void`	`setExclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)` Sets the exclusive start key for this query.
`void`	`setExpressionAttributeNames(Map<String,String> expressionAttributeNames)` One or more substitution variables for simplifying complex expressions.
`void`	`setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)` One or more values that can be substituted in an expression.
`void`	`setFilterExpression(String filterExpression)` Evaluates the query results and returns only the desired values.
`void`	`setHashKeyValues(T hashKeyValues)` Sets the hash key value(s) for this query.
`void`	`setIndexName(String indexName)` Sets the name of the index to be used by this query.
`void`	`setLimit(Integer limit)` Sets the maximum number of items to retrieve in each service request to DynamoDB.
`void`	`setQueryFilter(Map<String,Condition> queryFilter)` Sets the query filter applied on this query.
`void`	`setRangeKeyConditions(Map<String,Condition> rangeKeyConditions)` Sets the range key condition for this query.
`void`	`setScanIndexForward(boolean scanIndexForward)` Sets whether this query scans forward.
`DynamoDBQueryExpression<T>`	`withConditionalOperator(ConditionalOperator conditionalOperator)` Sets the logical operator on the query filter conditions.
`DynamoDBQueryExpression<T>`	`withConditionalOperator(String conditionalOperator)` Sets the logical operator on the query filter conditions.
`DynamoDBQueryExpression<T>`	`withConsistentRead(boolean consistentRead)` Sets whether this query uses consistent reads and returns a pointer to this object for method-chaining.
`DynamoDBQueryExpression<T>`	`withExclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)` Sets the exclusive start key for this query and returns a pointer to this object for method-chaining.
`DynamoDBQueryExpression<T>`	`withExpressionAttributeNames(Map<String,String> expressionAttributeNames)` One or more substitution variables for simplifying complex expressions.
`DynamoDBQueryExpression<T>`	`withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)` One or more values that can be substituted in an expression.
`DynamoDBQueryExpression<T>`	`withFilterExpression(String filterExpression)` Evaluates the query results and returns only the desired values.
`DynamoDBQueryExpression<T>`	`withHashKeyValues(T hashKObject)` Sets the hash key value(s) for this query.
`DynamoDBQueryExpression<T>`	`withIndexName(String indexName)` Sets the name of the index to be used by this query.
`DynamoDBQueryExpression<T>`	`withLimit(Integer 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.
`DynamoDBQueryExpression<T>`	`withQueryFilter(Map<String,Condition> queryFilter)` Sets the query filter applied on this query.
`DynamoDBQueryExpression<T>`	`withQueryFilterEntry(String attributeName, Condition condition)` Adds a new condition to the the query filter.
`DynamoDBQueryExpression<T>`	`withRangeKeyCondition(String rangeKeyAttributeName, Condition rangeKeyCondition)` Sets one range key condition for this query, using the attribute name of the range key.
`DynamoDBQueryExpression<T>`	`withRangeKeyConditions(Map<String,Condition> rangeKeyConditions)` Sets the range key condition for this query.
`DynamoDBQueryExpression<T>`	`withScanIndexForward(boolean scanIndexForward)` Sets whether this query scans forward and returns a pointer to this object for method-chaining.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DynamoDBQueryExpression
```
public DynamoDBQueryExpression()
```
- Method Detail
  - isConsistentRead
```
public boolean isConsistentRead()
```
    Returns whether this query uses consistent reads.
    
    Returns:
    
    true if its consistent reads, false otherwise
  - setConsistentRead
```
public void setConsistentRead(boolean consistentRead)
```
    Sets whether this query uses consistent reads.
    
    Parameters:
    
    consistentRead - set consistent read operation.
  - withConsistentRead
```
public DynamoDBQueryExpression<T> withConsistentRead(boolean consistentRead)
```
    Sets whether this query uses consistent reads and returns a pointer to this object for method-chaining.
    
    Parameters:
    
    consistentRead - set consistent read operation.
    
    Returns:
    
    updated DynamoDBQueryExpression for chaining
  - isScanIndexForward
```
public boolean isScanIndexForward()
```
    Returns whether this query scans forward.
    
    Returns:
    
    is query scans forward.
  - setScanIndexForward
```
public void setScanIndexForward(boolean scanIndexForward)
```
    Sets whether this query scans forward.
    
    Parameters:
    
    scanIndexForward - set query scans forward.
  - withScanIndexForward
```
public DynamoDBQueryExpression<T> withScanIndexForward(boolean scanIndexForward)
```
    Sets whether this query scans forward and returns a pointer to this object for method-chaining.
    
    Parameters:
    
    scanIndexForward - set query scans forward.
    
    Returns:
    
    updated DynamoDBQueryExpression for chaining
  - getExclusiveStartKey
```
public Map<String,AttributeValue> getExclusiveStartKey()
```
    Returns the exclusive start key for this query.
    
    Returns:
    
    a map of string to attribute value.
  - setExclusiveStartKey
```
public void setExclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)
```
    Sets the exclusive start key for this query.
    
    Parameters:
    
    exclusiveStartKey - a map of string to attribute value representing exlusive start key
  - withExclusiveStartKey
```
public DynamoDBQueryExpression<T> withExclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)
```
    Sets the exclusive start key for this query and returns a pointer to this object for method-chaining.
    
    Parameters:
    
    exclusiveStartKey - a map of string to attribute value representing exlusive start key
    
    Returns:
    
    updated DynamoDBQueryExpression for chaining
  - getLimit
```
public Integer getLimit()
```
    Returns the maximum number of items to retrieve in each service request to DynamoDB.
    Note that when calling 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 DynamoDBMapper.queryPage to retrieve a single page of items from DynamoDB.
    
    Returns:
    
    the query limit.
  - setLimit
```
public void setLimit(Integer limit)
```
    Sets the maximum number of items to retrieve in each service request to DynamoDB.
    Note that when calling 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 DynamoDBMapper.queryPage to retrieve a single page of items from DynamoDB.
    
    Parameters:
    
    limit - the query limit
  - withLimit
```
public DynamoDBQueryExpression<T> withLimit(Integer 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.
    Note that when calling 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 DynamoDBMapper.queryPage to retrieve a single page of items from DynamoDB.
    
    Parameters:
    
    limit - the query limit
    
    Returns:
    
    updated DynamoDBQueryExpression for chaining
  - getHashKeyValues
```
public T getHashKeyValues()
```
    Gets the hash key value(s) for this query. All hash key attributes for the table must be specified with this key object.
    
    Returns:
    
    the hash key values.
  - setHashKeyValues
```
public void setHashKeyValues(T 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.
    
    Parameters:
    
    hashKeyValues - the hash key values.
  - withHashKeyValues
```
public DynamoDBQueryExpression<T> withHashKeyValues(T hashKObject)
```
    Sets the hash key value(s) for this query. All hash key attributes for the table must be specified with this key object.
    
    Parameters:
    
    hashKObject - the hash key values.
    
    Returns:
    
    updated DynamoDBQueryExpression for chaining
  - getRangeKeyConditions
```
public Map<String,Condition> getRangeKeyConditions()
```
    Gets the range key condition for this query. All range key attributes for the table must be specified by attribute name in the map.
    
    Returns:
    
    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 an AmazonClientException.
  - setRangeKeyConditions
```
public void setRangeKeyConditions(Map<String,Condition> 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.
    
    Parameters:
    
    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 an AmazonClientException.
  - withRangeKeyConditions
```
public DynamoDBQueryExpression<T> withRangeKeyConditions(Map<String,Condition> 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.
    
    Parameters:
    
    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 an AmazonClientException.
    
    Returns:
    
    updated DynamoDBQueryExpression for chaining
  - withRangeKeyCondition
```
public DynamoDBQueryExpression<T> withRangeKeyCondition(String rangeKeyAttributeName,
                                                        Condition rangeKeyCondition)
```
    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 DynamoDBRangeKey or DynamoDBIndexRangeKey annotations before executing the query.
    
    If the attribute is the primary range key
    
    users should NOT set any index name for this query.
    
    If the attribute is an index range key
    
    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 setIndexName(String) or withIndexName(String).
    
    Parameters:
    
    rangeKeyAttributeName - This can be either the primary range key of the table or an index range key.
    
    rangeKeyCondition - Condition specified on the given range key for this query.
    
    Returns:
    
    updated DynamoDBQueryExpression for chaining
  - getIndexName
```
public String getIndexName()
```
    Returns the name of the index to be used by this query.
    
    Returns:
    
    the index name used for the query.
  - setIndexName
```
public void setIndexName(String 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 DynamoDBIndexHashKey or DynamoDBIndexRangeKey annotations to the appropriate getter methods of the mapped object.
    
    Parameters:
    
    indexName - the index name to use for the query.
  - withIndexName
```
public DynamoDBQueryExpression<T> withIndexName(String 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 DynamoDBIndexHashKey or DynamoDBIndexRangeKey annotations to the appropriate getter methods of the mapped object.
    Returns a pointer to this object for method-chaining.
    
    Parameters:
    
    indexName - the index name to use for the query.
    
    Returns:
    
    updated DynamoDBQueryExpression for chaining
  - getQueryFilter
```
public Map<String,Condition> getQueryFilter()
```
    Returns the query filter applied on this query.
    
    Returns:
    
    a map of string to Condition representing the query filter.
  - setQueryFilter
```
public void setQueryFilter(Map<String,Condition> queryFilter)
```
    Sets the query filter applied on this query.
    
    Parameters:
    
    queryFilter - a map of string to Condition representing the query filter.
  - withQueryFilter
```
public DynamoDBQueryExpression<T> withQueryFilter(Map<String,Condition> queryFilter)
```
    Sets the query filter applied on this query.
    Returns a pointer to this object for method-chaining.
    
    Parameters:
    
    queryFilter - a map of string to Condition representing the query filter.
    
    Returns:
    
    updated DynamoDBQueryExpression for chaining
  - withQueryFilterEntry
```
public DynamoDBQueryExpression<T> withQueryFilterEntry(String attributeName,
                                                       Condition condition)
```
    Adds a new condition to the the query filter.
    Returns a pointer to this object for method-chaining.
    
    Parameters:
    
    attributeName - The name of the attribute on which the specified condition operates.
    
    condition - The filter condition applied on the attribute.
    
    Returns:
    
    updated DynamoDBQueryExpression for chainingv
  - getConditionalOperator
```
public String getConditionalOperator()
```
    Returns the logical operator on the query filter conditions.
    
    Returns:
    
    the conditional operator.
  - setConditionalOperator
```
public void setConditionalOperator(String conditionalOperator)
```
    Sets the logical operator on the query filter conditions.
    
    Parameters:
    
    conditionalOperator - the conditional operator.
  - withConditionalOperator
```
public DynamoDBQueryExpression<T> withConditionalOperator(String conditionalOperator)
```
    Sets the logical operator on the query filter conditions.
    Returns a pointer to this object for method-chaining.
    
    Parameters:
    
    conditionalOperator - the conditional operator.
    
    Returns:
    
    updated DynamoDBQueryExpression for chaining
  - setConditionalOperator
```
public void setConditionalOperator(ConditionalOperator conditionalOperator)
```
    Sets the logical operator on the query filter conditions.
    
    Parameters:
    
    conditionalOperator - the conditional operator.s
  - withConditionalOperator
```
public DynamoDBQueryExpression<T> withConditionalOperator(ConditionalOperator conditionalOperator)
```
    Sets the logical operator on the query filter conditions.
    Returns a pointer to this object for method-chaining.
    
    Parameters:
    
    conditionalOperator - the conditional operator.
    
    Returns:
    
    updated DynamoDBQueryExpression for chainingv
  - getFilterExpression
```
public String getFilterExpression()
```
    Evaluates the query results and returns only the desired values.
    The condition you specify is applied to the items queried; any items that do not match the expression are not returned.
    
    Returns:
    
    Evaluates the query results and returns only the desired values.
    The condition you specify is applied to the items queried; any items that do not match the expression are not returned.
    
    See Also:
    
    QueryRequest.getFilterExpression()
  - setFilterExpression
```
public void setFilterExpression(String filterExpression)
```
    Evaluates the query results and returns only the desired values.
    The condition you specify is applied to the items queried; any items that do not match the expression are not returned.
    
    Parameters:
    
    filterExpression - Evaluates the query results and returns only the desired values.
    The condition you specify is applied to the items queried; any items that do not match the expression are not returned.
    
    See Also:
    
    QueryRequest.setFilterExpression(String)
  - withFilterExpression
```
public DynamoDBQueryExpression<T> withFilterExpression(String filterExpression)
```
    Evaluates the query results and returns only the desired values.
    The condition you specify is applied to the items queried; any items that do not match the expression are not returned.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    filterExpression - Evaluates the query results and returns only the desired values.
    The condition you specify is applied to the items queried; any items that do not match the expression are not returned.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    QueryRequest.withFilterExpression(String)
  - getExpressionAttributeNames
```
public Map<String,String> getExpressionAttributeNames()
```
    One or more substitution variables for simplifying complex expressions.
    
    Returns:
    
    One or more substitution variables for simplifying complex expressions.
    
    See Also:
    
    QueryRequest.getExpressionAttributeNames()
  - setExpressionAttributeNames
```
public void setExpressionAttributeNames(Map<String,String> expressionAttributeNames)
```
    One or more substitution variables for simplifying complex expressions.
    
    Parameters:
    
    expressionAttributeNames - One or more substitution variables for simplifying complex expressions.
    
    See Also:
    
    QueryRequest.setExpressionAttributeNames(Map)
  - withExpressionAttributeNames
```
public DynamoDBQueryExpression<T> withExpressionAttributeNames(Map<String,String> expressionAttributeNames)
```
    One or more substitution variables for simplifying complex expressions.
    
    Parameters:
    
    expressionAttributeNames - One or more substitution variables for simplifying complex expressions.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    QueryRequest.withExpressionAttributeNames(Map)
  - addExpressionAttributeNamesEntry
```
public DynamoDBQueryExpression<T> addExpressionAttributeNamesEntry(String key,
                                                                   String value)
```
    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.
    
    Parameters:
    
    key - The key of the entry to be added into ExpressionAttributeNames.
    
    value - The corresponding value of the entry to be added into ExpressionAttributeNames.
    
    Returns:
    
    updated DynamoDBQueryExpression for chainingv
    
    See Also:
    
    QueryRequest.addExpressionAttributeNamesEntry(String, String)
  - clearExpressionAttributeNamesEntries
```
public DynamoDBQueryExpression<T> clearExpressionAttributeNamesEntries()
```
    Removes all the entries added into ExpressionAttributeNames. Setting ExpressionAttributeNames to null.
    Returns a reference to this object so that method calls can be chained together.
    
    Returns:
    
    updated DynamoDBQueryExpression for chaining
  - getExpressionAttributeValues
```
public Map<String,AttributeValue> getExpressionAttributeValues()
```
    One or more values that can be substituted in an expression.
    
    Returns:
    
    One or more values that can be substituted in an expression.
    
    See Also:
    
    QueryRequest.getExpressionAttributeValues()
  - setExpressionAttributeValues
```
public void setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
```
    One or more values that can be substituted in an expression.
    
    Parameters:
    
    expressionAttributeValues - One or more values that can be substituted in an expression.
    
    See Also:
    
    QueryRequest.setExpressionAttributeValues(Map)
  - withExpressionAttributeValues
```
public DynamoDBQueryExpression<T> withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
```
    One or more values that can be substituted in an expression.
    
    Parameters:
    
    expressionAttributeValues - One or more values that can be substituted in an expression.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    QueryRequest.withExpressionAttributeValues(Map)
  - addExpressionAttributeValuesEntry
```
public DynamoDBQueryExpression<T> addExpressionAttributeValuesEntry(String key,
                                                                    AttributeValue value)
```
    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.
    
    Parameters:
    
    key - The key of the entry to be added into ExpressionAttributeValues.
    
    value - The corresponding value of the entry to be added into ExpressionAttributeValues.
    
    Returns:
    
    updated DynamoDBQueryExpression for chaining
    
    See Also:
    
    QueryRequest.addExpressionAttributeValuesEntry(String, AttributeValue)
  - clearExpressionAttributeValuesEntries
```
public DynamoDBQueryExpression<T> clearExpressionAttributeValuesEntries()
```
    Removes all the entries added into ExpressionAttributeValues. Setting ExpressionAttributeValues to null.
    Returns a reference to this object so that method calls can be chained together.
    
    Returns:
    
    updated DynamoDBQueryExpression for chaining

Class DynamoDBQueryExpression<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DynamoDBQueryExpression

Method Detail

isConsistentRead

setConsistentRead

withConsistentRead

isScanIndexForward

setScanIndexForward

withScanIndexForward

getExclusiveStartKey

setExclusiveStartKey

withExclusiveStartKey

getLimit

setLimit

withLimit

getHashKeyValues

setHashKeyValues

withHashKeyValues

getRangeKeyConditions

setRangeKeyConditions

withRangeKeyConditions

withRangeKeyCondition

getIndexName

setIndexName

withIndexName

getQueryFilter

setQueryFilter

withQueryFilter

withQueryFilterEntry

getConditionalOperator

setConditionalOperator

withConditionalOperator

setConditionalOperator

withConditionalOperator

getFilterExpression

setFilterExpression

withFilterExpression

getExpressionAttributeNames

setExpressionAttributeNames

withExpressionAttributeNames

addExpressionAttributeNamesEntry

clearExpressionAttributeNamesEntries

getExpressionAttributeValues

setExpressionAttributeValues

withExpressionAttributeValues

addExpressionAttributeValuesEntry

clearExpressionAttributeValuesEntries