public class QueryRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable
Query operation.
A Query operation directly accesses items from a table using the table primary key, or from an index using the index key. You must provide a specific hash key value. You can narrow the scope of the query by using comparison operators on the range key value, or on the index key. You can use the ScanIndexForward parameter to get results in forward or reverse order, by range key or by index key.
Queries that do not return results consume the minimum number of read capacity units for that type of read operation.
If the total number of items meeting the query criteria exceeds the result set size limit of 1 MB, the query stops and results are returned to the user with LastEvaluatedKey to continue the query in a subsequent operation. Unlike a Scan operation, a Query operation never returns both an empty result set and a LastEvaluatedKey . The LastEvaluatedKey is only provided if the results exceed 1 MB, or if you have used Limit .
You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set ConsistentRead to true and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify ConsistentRead when querying a global secondary index.
| Constructor and Description |
|---|
QueryRequest()
Default constructor for a new QueryRequest object.
|
QueryRequest(String tableName)
Constructs a new QueryRequest object.
|
| Modifier and Type | Method and Description |
|---|---|
QueryRequest |
addExclusiveStartKeyEntry(String key,
AttributeValue value)
The primary key of the first item that this operation will evaluate.
|
QueryRequest |
addExpressionAttributeNamesEntry(String key,
String value)
One or more substitution tokens for simplifying complex expressions.
|
QueryRequest |
addExpressionAttributeValuesEntry(String key,
AttributeValue value)
One or more values that can be substituted in an expression.
|
QueryRequest |
addKeyConditionsEntry(String key,
Condition value)
The selection criteria for the query.
|
QueryRequest |
addQueryFilterEntry(String key,
Condition value)
|
QueryRequest |
clearExclusiveStartKeyEntries()
Removes all the entries added into ExclusiveStartKey.
|
QueryRequest |
clearExpressionAttributeNamesEntries()
Removes all the entries added into ExpressionAttributeNames.
|
QueryRequest |
clearExpressionAttributeValuesEntries()
Removes all the entries added into ExpressionAttributeValues.
|
QueryRequest |
clearKeyConditionsEntries()
Removes all the entries added into KeyConditions.
|
QueryRequest |
clearQueryFilterEntries()
Removes all the entries added into QueryFilter.
|
boolean |
equals(Object obj) |
List<String> |
getAttributesToGet()
|
String |
getConditionalOperator()
|
Boolean |
getConsistentRead()
A value that if set to
true, then the operation uses
strongly consistent reads; otherwise, eventually consistent reads are
used. |
Map<String,AttributeValue> |
getExclusiveStartKey()
The primary key of the first item that this operation will evaluate.
|
Map<String,String> |
getExpressionAttributeNames()
One or more substitution tokens for simplifying complex expressions.
|
Map<String,AttributeValue> |
getExpressionAttributeValues()
One or more values that can be substituted in an expression.
|
String |
getFilterExpression()
A condition that evaluates the query results and returns only the
desired values.
|
String |
getIndexName()
The name of an index to query.
|
Map<String,Condition> |
getKeyConditions()
The selection criteria for the query.
|
Integer |
getLimit()
The maximum number of items to evaluate (not necessarily the number of
matching items).
|
String |
getProjectionExpression()
One or more attributes to retrieve from the table.
|
Map<String,Condition> |
getQueryFilter()
|
String |
getReturnConsumedCapacity()
A value that if set to
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. |
Boolean |
getScanIndexForward()
A value that specifies ascending (true) or descending (false)
traversal of the index.
|
String |
getSelect()
The attributes to be returned in the result.
|
String |
getTableName()
The name of the table containing the requested items.
|
int |
hashCode() |
Boolean |
isConsistentRead()
A value that if set to
true, then the operation uses
strongly consistent reads; otherwise, eventually consistent reads are
used. |
Boolean |
isScanIndexForward()
A value that specifies ascending (true) or descending (false)
traversal of the index.
|
void |
setAttributesToGet(Collection<String> attributesToGet)
|
void |
setConditionalOperator(ConditionalOperator conditionalOperator)
|
void |
setConditionalOperator(String conditionalOperator)
|
void |
setConsistentRead(Boolean consistentRead)
A value that if set to
true, then the operation uses
strongly consistent reads; otherwise, eventually consistent reads are
used. |
void |
setExclusiveStartKey(Map.Entry<String,AttributeValue> hashKey,
Map.Entry<String,AttributeValue> rangeKey)
The primary key of the first item that this operation will evaluate.
|
void |
setExclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)
The primary key of the first item that this operation will evaluate.
|
void |
setExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens 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)
A condition that evaluates the query results and returns only the
desired values.
|
void |
setIndexName(String indexName)
The name of an index to query.
|
void |
setKeyConditions(Map<String,Condition> keyConditions)
The selection criteria for the query.
|
void |
setLimit(Integer limit)
The maximum number of items to evaluate (not necessarily the number of
matching items).
|
void |
setProjectionExpression(String projectionExpression)
One or more attributes to retrieve from the table.
|
void |
setQueryFilter(Map<String,Condition> queryFilter)
|
void |
setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
A value that if set to
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. |
void |
setReturnConsumedCapacity(String returnConsumedCapacity)
A value that if set to
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. |
void |
setScanIndexForward(Boolean scanIndexForward)
A value that specifies ascending (true) or descending (false)
traversal of the index.
|
void |
setSelect(Select select)
The attributes to be returned in the result.
|
void |
setSelect(String select)
The attributes to be returned in the result.
|
void |
setTableName(String tableName)
The name of the table containing the requested items.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
QueryRequest |
withAttributesToGet(Collection<String> attributesToGet)
|
QueryRequest |
withAttributesToGet(String... attributesToGet)
|
QueryRequest |
withConditionalOperator(ConditionalOperator conditionalOperator)
|
QueryRequest |
withConditionalOperator(String conditionalOperator)
|
QueryRequest |
withConsistentRead(Boolean consistentRead)
A value that if set to
true, then the operation uses
strongly consistent reads; otherwise, eventually consistent reads are
used. |
QueryRequest |
withExclusiveStartKey(Map.Entry<String,AttributeValue> hashKey,
Map.Entry<String,AttributeValue> rangeKey)
The primary key of the first item that this operation will evaluate.
|
QueryRequest |
withExclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)
The primary key of the first item that this operation will evaluate.
|
QueryRequest |
withExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for simplifying complex expressions.
|
QueryRequest |
withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
QueryRequest |
withFilterExpression(String filterExpression)
A condition that evaluates the query results and returns only the
desired values.
|
QueryRequest |
withIndexName(String indexName)
The name of an index to query.
|
QueryRequest |
withKeyConditions(Map<String,Condition> keyConditions)
The selection criteria for the query.
|
QueryRequest |
withLimit(Integer limit)
The maximum number of items to evaluate (not necessarily the number of
matching items).
|
QueryRequest |
withProjectionExpression(String projectionExpression)
One or more attributes to retrieve from the table.
|
QueryRequest |
withQueryFilter(Map<String,Condition> queryFilter)
|
QueryRequest |
withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
A value that if set to
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. |
QueryRequest |
withReturnConsumedCapacity(String returnConsumedCapacity)
A value that if set to
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. |
QueryRequest |
withScanIndexForward(Boolean scanIndexForward)
A value that specifies ascending (true) or descending (false)
traversal of the index.
|
QueryRequest |
withSelect(Select select)
The attributes to be returned in the result.
|
QueryRequest |
withSelect(String select)
The attributes to be returned in the result.
|
QueryRequest |
withTableName(String tableName)
The name of the table containing the requested items.
|
copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic QueryRequest()
public QueryRequest(String tableName)
tableName - The name of the table containing the requested items.public String getTableName()
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
public void setTableName(String tableName)
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
tableName - The name of the table containing the requested items.public QueryRequest withTableName(String tableName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
tableName - The name of the table containing the requested items.public String getIndexName()
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
public void setIndexName(String indexName)
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
indexName - The name of an index to query. This index can be any local secondary
index or global secondary index on the table.public QueryRequest withIndexName(String indexName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
indexName - The name of an index to query. This index can be any local secondary
index or global secondary index on the table.public String getSelect()
ALL_ATTRIBUTES - 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.
ALL_PROJECTED_ATTRIBUTES -
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
ALL_ATTRIBUTES.
COUNT -
Returns the number of matching items, rather than the matching items
themselves.
SPECIFIC_ATTRIBUTES - Returns
only the attributes listed in AttributesToGet. This return
value is equivalent to specifying AttributesToGet without
specifying any value for Select.
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.
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.
If neither Select nor AttributesToGet are
specified, DynamoDB defaults to ALL_ATTRIBUTES when
accessing a table, and ALL_PROJECTED_ATTRIBUTES when
accessing an index. You cannot use both Select and
AttributesToGet together in a single request, unless the value
for Select is SPECIFIC_ATTRIBUTES. (This usage is
equivalent to specifying AttributesToGet without any value for
Select.)
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
ALL_ATTRIBUTES - 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.
ALL_PROJECTED_ATTRIBUTES -
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
ALL_ATTRIBUTES.
COUNT -
Returns the number of matching items, rather than the matching items
themselves.
SPECIFIC_ATTRIBUTES - Returns
only the attributes listed in AttributesToGet. This return
value is equivalent to specifying AttributesToGet without
specifying any value for Select.
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.
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.
If neither Select nor AttributesToGet are
specified, DynamoDB defaults to ALL_ATTRIBUTES when
accessing a table, and ALL_PROJECTED_ATTRIBUTES when
accessing an index. You cannot use both Select and
AttributesToGet together in a single request, unless the value
for Select is SPECIFIC_ATTRIBUTES. (This usage is
equivalent to specifying AttributesToGet without any value for
Select.)
Selectpublic void setSelect(String select)
ALL_ATTRIBUTES - 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.
ALL_PROJECTED_ATTRIBUTES -
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
ALL_ATTRIBUTES.
COUNT -
Returns the number of matching items, rather than the matching items
themselves.
SPECIFIC_ATTRIBUTES - Returns
only the attributes listed in AttributesToGet. This return
value is equivalent to specifying AttributesToGet without
specifying any value for Select.
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.
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.
If neither Select nor AttributesToGet are
specified, DynamoDB defaults to ALL_ATTRIBUTES when
accessing a table, and ALL_PROJECTED_ATTRIBUTES when
accessing an index. You cannot use both Select and
AttributesToGet together in a single request, unless the value
for Select is SPECIFIC_ATTRIBUTES. (This usage is
equivalent to specifying AttributesToGet without any value for
Select.)
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
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. ALL_ATTRIBUTES - 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.
ALL_PROJECTED_ATTRIBUTES -
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
ALL_ATTRIBUTES.
COUNT -
Returns the number of matching items, rather than the matching items
themselves.
SPECIFIC_ATTRIBUTES - Returns
only the attributes listed in AttributesToGet. This return
value is equivalent to specifying AttributesToGet without
specifying any value for Select.
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.
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.
If neither Select nor AttributesToGet are
specified, DynamoDB defaults to ALL_ATTRIBUTES when
accessing a table, and ALL_PROJECTED_ATTRIBUTES when
accessing an index. You cannot use both Select and
AttributesToGet together in a single request, unless the value
for Select is SPECIFIC_ATTRIBUTES. (This usage is
equivalent to specifying AttributesToGet without any value for
Select.)
Selectpublic QueryRequest withSelect(String select)
ALL_ATTRIBUTES - 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.
ALL_PROJECTED_ATTRIBUTES -
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
ALL_ATTRIBUTES.
COUNT -
Returns the number of matching items, rather than the matching items
themselves.
SPECIFIC_ATTRIBUTES - Returns
only the attributes listed in AttributesToGet. This return
value is equivalent to specifying AttributesToGet without
specifying any value for Select.
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.
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.
If neither Select nor AttributesToGet are
specified, DynamoDB defaults to ALL_ATTRIBUTES when
accessing a table, and ALL_PROJECTED_ATTRIBUTES when
accessing an index. You cannot use both Select and
AttributesToGet together in a single request, unless the value
for Select is SPECIFIC_ATTRIBUTES. (This usage is
equivalent to specifying AttributesToGet without any value for
Select.)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
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. ALL_ATTRIBUTES - 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.
ALL_PROJECTED_ATTRIBUTES -
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
ALL_ATTRIBUTES.
COUNT -
Returns the number of matching items, rather than the matching items
themselves.
SPECIFIC_ATTRIBUTES - Returns
only the attributes listed in AttributesToGet. This return
value is equivalent to specifying AttributesToGet without
specifying any value for Select.
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.
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.
If neither Select nor AttributesToGet are
specified, DynamoDB defaults to ALL_ATTRIBUTES when
accessing a table, and ALL_PROJECTED_ATTRIBUTES when
accessing an index. You cannot use both Select and
AttributesToGet together in a single request, unless the value
for Select is SPECIFIC_ATTRIBUTES. (This usage is
equivalent to specifying AttributesToGet without any value for
Select.)
Selectpublic void setSelect(Select select)
ALL_ATTRIBUTES - 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.
ALL_PROJECTED_ATTRIBUTES -
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
ALL_ATTRIBUTES.
COUNT -
Returns the number of matching items, rather than the matching items
themselves.
SPECIFIC_ATTRIBUTES - Returns
only the attributes listed in AttributesToGet. This return
value is equivalent to specifying AttributesToGet without
specifying any value for Select.
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.
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.
If neither Select nor AttributesToGet are
specified, DynamoDB defaults to ALL_ATTRIBUTES when
accessing a table, and ALL_PROJECTED_ATTRIBUTES when
accessing an index. You cannot use both Select and
AttributesToGet together in a single request, unless the value
for Select is SPECIFIC_ATTRIBUTES. (This usage is
equivalent to specifying AttributesToGet without any value for
Select.)
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
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. ALL_ATTRIBUTES - 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.
ALL_PROJECTED_ATTRIBUTES -
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
ALL_ATTRIBUTES.
COUNT -
Returns the number of matching items, rather than the matching items
themselves.
SPECIFIC_ATTRIBUTES - Returns
only the attributes listed in AttributesToGet. This return
value is equivalent to specifying AttributesToGet without
specifying any value for Select.
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.
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.
If neither Select nor AttributesToGet are
specified, DynamoDB defaults to ALL_ATTRIBUTES when
accessing a table, and ALL_PROJECTED_ATTRIBUTES when
accessing an index. You cannot use both Select and
AttributesToGet together in a single request, unless the value
for Select is SPECIFIC_ATTRIBUTES. (This usage is
equivalent to specifying AttributesToGet without any value for
Select.)
Selectpublic QueryRequest withSelect(Select select)
ALL_ATTRIBUTES - 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.
ALL_PROJECTED_ATTRIBUTES -
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
ALL_ATTRIBUTES.
COUNT -
Returns the number of matching items, rather than the matching items
themselves.
SPECIFIC_ATTRIBUTES - Returns
only the attributes listed in AttributesToGet. This return
value is equivalent to specifying AttributesToGet without
specifying any value for Select.
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.
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.
If neither Select nor AttributesToGet are
specified, DynamoDB defaults to ALL_ATTRIBUTES when
accessing a table, and ALL_PROJECTED_ATTRIBUTES when
accessing an index. You cannot use both Select and
AttributesToGet together in a single request, unless the value
for Select is SPECIFIC_ATTRIBUTES. (This usage is
equivalent to specifying AttributesToGet without any value for
Select.)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
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. ALL_ATTRIBUTES - 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.
ALL_PROJECTED_ATTRIBUTES -
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
ALL_ATTRIBUTES.
COUNT -
Returns the number of matching items, rather than the matching items
themselves.
SPECIFIC_ATTRIBUTES - Returns
only the attributes listed in AttributesToGet. This return
value is equivalent to specifying AttributesToGet without
specifying any value for Select.
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.
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.
If neither Select nor AttributesToGet are
specified, DynamoDB defaults to ALL_ATTRIBUTES when
accessing a table, and ALL_PROJECTED_ATTRIBUTES when
accessing an index. You cannot use both Select and
AttributesToGet together in a single request, unless the value
for Select is SPECIFIC_ATTRIBUTES. (This usage is
equivalent to specifying AttributesToGet without any value for
Select.)
Selectpublic List<String> getAttributesToGet()
There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. 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.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both
AttributesToGet and Select together in a Query
request, unless the value for Select is
SPECIFIC_ATTRIBUTES. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
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.
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.
Constraints:
Length: 1 -
There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. 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.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both
AttributesToGet and Select together in a Query
request, unless the value for Select is
SPECIFIC_ATTRIBUTES. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
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.
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.
public void setAttributesToGet(Collection<String> attributesToGet)
There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. 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.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both
AttributesToGet and Select together in a Query
request, unless the value for Select is
SPECIFIC_ATTRIBUTES. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
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.
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.
Constraints:
Length: 1 -
attributesToGet - There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. 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.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both
AttributesToGet and Select together in a Query
request, unless the value for Select is
SPECIFIC_ATTRIBUTES. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
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.
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.
public QueryRequest withAttributesToGet(String... attributesToGet)
There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. 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.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both
AttributesToGet and Select together in a Query
request, unless the value for Select is
SPECIFIC_ATTRIBUTES. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
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.
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 -
attributesToGet - There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. 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.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both
AttributesToGet and Select together in a Query
request, unless the value for Select is
SPECIFIC_ATTRIBUTES. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
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.
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.
public QueryRequest withAttributesToGet(Collection<String> attributesToGet)
There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. 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.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both
AttributesToGet and Select together in a Query
request, unless the value for Select is
SPECIFIC_ATTRIBUTES. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
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.
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 -
attributesToGet - There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. 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.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both
AttributesToGet and Select together in a Query
request, unless the value for Select is
SPECIFIC_ATTRIBUTES. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
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.
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.
public Integer getLimit()
Constraints:
Range: 1 -
public void setLimit(Integer limit)
Constraints:
Range: 1 -
limit - The maximum number of items to evaluate (not necessarily the number of
matching items). If DynamoDB processes the number of items up to the
limit while processing the results, it stops the operation and returns
the matching values up to that point, and a key in
LastEvaluatedKey to apply in a subsequent operation, so that
you can pick up where you left off. Also, if the processed data set
size exceeds 1 MB before DynamoDB reaches this limit, it stops the
operation and returns the matching values up to the limit, and a key
in LastEvaluatedKey to apply in a subsequent operation to
continue the operation. For more information, see Query
and Scan in the Amazon DynamoDB Developer Guide.public QueryRequest withLimit(Integer limit)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 -
limit - The maximum number of items to evaluate (not necessarily the number of
matching items). If DynamoDB processes the number of items up to the
limit while processing the results, it stops the operation and returns
the matching values up to that point, and a key in
LastEvaluatedKey to apply in a subsequent operation, so that
you can pick up where you left off. Also, if the processed data set
size exceeds 1 MB before DynamoDB reaches this limit, it stops the
operation and returns the matching values up to the limit, and a key
in LastEvaluatedKey to apply in a subsequent operation to
continue the operation. For more information, see Query
and Scan in the Amazon DynamoDB Developer Guide.public Boolean isConsistentRead()
true, then the operation uses
strongly consistent reads; otherwise, eventually consistent reads are
used. Strongly consistent reads are not supported on global
secondary indexes. If you query a global secondary index with
ConsistentRead set to true, you will receive an
error message.
true, then the operation uses
strongly consistent reads; otherwise, eventually consistent reads are
used. Strongly consistent reads are not supported on global
secondary indexes. If you query a global secondary index with
ConsistentRead set to true, you will receive an
error message.
public void setConsistentRead(Boolean consistentRead)
true, then the operation uses
strongly consistent reads; otherwise, eventually consistent reads are
used. Strongly consistent reads are not supported on global
secondary indexes. If you query a global secondary index with
ConsistentRead set to true, you will receive an
error message.
consistentRead - A value that if set to true, then the operation uses
strongly consistent reads; otherwise, eventually consistent reads are
used. Strongly consistent reads are not supported on global
secondary indexes. If you query a global secondary index with
ConsistentRead set to true, you will receive an
error message.
public QueryRequest withConsistentRead(Boolean consistentRead)
true, then the operation uses
strongly consistent reads; otherwise, eventually consistent reads are
used. Strongly consistent reads are not supported on global
secondary indexes. If you query a global secondary index with
ConsistentRead set to true, you will receive an
error message.
Returns a reference to this object so that method calls can be chained together.
consistentRead - A value that if set to true, then the operation uses
strongly consistent reads; otherwise, eventually consistent reads are
used. Strongly consistent reads are not supported on global
secondary indexes. If you query a global secondary index with
ConsistentRead set to true, you will receive an
error message.
public Boolean getConsistentRead()
true, then the operation uses
strongly consistent reads; otherwise, eventually consistent reads are
used. Strongly consistent reads are not supported on global
secondary indexes. If you query a global secondary index with
ConsistentRead set to true, you will receive an
error message.
true, then the operation uses
strongly consistent reads; otherwise, eventually consistent reads are
used. Strongly consistent reads are not supported on global
secondary indexes. If you query a global secondary index with
ConsistentRead set to true, you will receive an
error message.
public Map<String,Condition> getKeyConditions()
EQ
condition. You can optionally specify a second condition, referring to
the range key attribute. For a query on an index, you can have conditions only on the index key attributes. You must specify the index hash attribute name and value as an EQ condition. You can optionally specify a second condition, referring to the index key range attribute.
Each KeyConditions element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than,
equals, or less than are based on ASCII character code values. For
example, a is greater than A, and
aa is greater than B. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
ComparisonOperator - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on.
For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT |
GE | GT | BEGINS_WITH | BETWEEN
The following are descriptions of these comparison operators.
EQ : Equal.
AttributeValueList can contain
only one AttributeValue of type String, Number, or Binary (not
a set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not equal
{"NS":["6", "2", "1"]}.
LE : Less than or equal.
AttributeValueList
can contain only one AttributeValue element of type String,
Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
LT : Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
BEGINS_WITH : Checks for
a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
BETWEEN : Greater than or equal to the first value,
and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
EQ
condition. You can optionally specify a second condition, referring to
the range key attribute. For a query on an index, you can have conditions only on the index key attributes. You must specify the index hash attribute name and value as an EQ condition. You can optionally specify a second condition, referring to the index key range attribute.
Each KeyConditions element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than,
equals, or less than are based on ASCII character code values. For
example, a is greater than A, and
aa is greater than B. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
ComparisonOperator - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on.
For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT |
GE | GT | BEGINS_WITH | BETWEEN
The following are descriptions of these comparison operators.
EQ : Equal.
AttributeValueList can contain
only one AttributeValue of type String, Number, or Binary (not
a set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not equal
{"NS":["6", "2", "1"]}.
LE : Less than or equal.
AttributeValueList
can contain only one AttributeValue element of type String,
Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
LT : Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
BEGINS_WITH : Checks for
a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
BETWEEN : Greater than or equal to the first value,
and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
public void setKeyConditions(Map<String,Condition> keyConditions)
EQ
condition. You can optionally specify a second condition, referring to
the range key attribute. For a query on an index, you can have conditions only on the index key attributes. You must specify the index hash attribute name and value as an EQ condition. You can optionally specify a second condition, referring to the index key range attribute.
Each KeyConditions element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than,
equals, or less than are based on ASCII character code values. For
example, a is greater than A, and
aa is greater than B. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
ComparisonOperator - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on.
For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT |
GE | GT | BEGINS_WITH | BETWEEN
The following are descriptions of these comparison operators.
EQ : Equal.
AttributeValueList can contain
only one AttributeValue of type String, Number, or Binary (not
a set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not equal
{"NS":["6", "2", "1"]}.
LE : Less than or equal.
AttributeValueList
can contain only one AttributeValue element of type String,
Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
LT : Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
BEGINS_WITH : Checks for
a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
BETWEEN : Greater than or equal to the first value,
and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
keyConditions - The selection criteria for the query. For a query on a table, you can
have conditions only on the table primary key attributes. You must
specify the hash key attribute name and value as an EQ
condition. You can optionally specify a second condition, referring to
the range key attribute. For a query on an index, you can have conditions only on the index key attributes. You must specify the index hash attribute name and value as an EQ condition. You can optionally specify a second condition, referring to the index key range attribute.
Each KeyConditions element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than,
equals, or less than are based on ASCII character code values. For
example, a is greater than A, and
aa is greater than B. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
ComparisonOperator - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on.
For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT |
GE | GT | BEGINS_WITH | BETWEEN
The following are descriptions of these comparison operators.
EQ : Equal.
AttributeValueList can contain
only one AttributeValue of type String, Number, or Binary (not
a set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not equal
{"NS":["6", "2", "1"]}.
LE : Less than or equal.
AttributeValueList
can contain only one AttributeValue element of type String,
Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
LT : Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
BEGINS_WITH : Checks for
a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
BETWEEN : Greater than or equal to the first value,
and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
public QueryRequest withKeyConditions(Map<String,Condition> keyConditions)
EQ
condition. You can optionally specify a second condition, referring to
the range key attribute. For a query on an index, you can have conditions only on the index key attributes. You must specify the index hash attribute name and value as an EQ condition. You can optionally specify a second condition, referring to the index key range attribute.
Each KeyConditions element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than,
equals, or less than are based on ASCII character code values. For
example, a is greater than A, and
aa is greater than B. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
ComparisonOperator - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on.
For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT |
GE | GT | BEGINS_WITH | BETWEEN
The following are descriptions of these comparison operators.
EQ : Equal.
AttributeValueList can contain
only one AttributeValue of type String, Number, or Binary (not
a set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not equal
{"NS":["6", "2", "1"]}.
LE : Less than or equal.
AttributeValueList
can contain only one AttributeValue element of type String,
Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
LT : Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
BEGINS_WITH : Checks for
a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
BETWEEN : Greater than or equal to the first value,
and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
Returns a reference to this object so that method calls can be chained together.
keyConditions - The selection criteria for the query. For a query on a table, you can
have conditions only on the table primary key attributes. You must
specify the hash key attribute name and value as an EQ
condition. You can optionally specify a second condition, referring to
the range key attribute. For a query on an index, you can have conditions only on the index key attributes. You must specify the index hash attribute name and value as an EQ condition. You can optionally specify a second condition, referring to the index key range attribute.
Each KeyConditions element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than,
equals, or less than are based on ASCII character code values. For
example, a is greater than A, and
aa is greater than B. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
ComparisonOperator - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on.
For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT |
GE | GT | BEGINS_WITH | BETWEEN
The following are descriptions of these comparison operators.
EQ : Equal.
AttributeValueList can contain
only one AttributeValue of type String, Number, or Binary (not
a set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not equal
{"NS":["6", "2", "1"]}.
LE : Less than or equal.
AttributeValueList
can contain only one AttributeValue element of type String,
Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
LT : Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
BEGINS_WITH : Checks for
a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
BETWEEN : Greater than or equal to the first value,
and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
public QueryRequest addKeyConditionsEntry(String key, Condition value)
EQ
condition. You can optionally specify a second condition, referring to
the range key attribute. For a query on an index, you can have conditions only on the index key attributes. You must specify the index hash attribute name and value as an EQ condition. You can optionally specify a second condition, referring to the index key range attribute.
Each KeyConditions element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than,
equals, or less than are based on ASCII character code values. For
example, a is greater than A, and
aa is greater than B. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
ComparisonOperator - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on.
For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT |
GE | GT | BEGINS_WITH | BETWEEN
The following are descriptions of these comparison operators.
EQ : Equal.
AttributeValueList can contain
only one AttributeValue of type String, Number, or Binary (not
a set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not equal
{"NS":["6", "2", "1"]}.
LE : Less than or equal.
AttributeValueList
can contain only one AttributeValue element of type String,
Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
LT : Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
BEGINS_WITH : Checks for
a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
BETWEEN : Greater than or equal to the first value,
and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
The method adds a new key-value pair into KeyConditions parameter, and returns a reference to this object so that method calls can be chained together.
key - The key of the entry to be added into KeyConditions.value - The corresponding value of the entry to be added into KeyConditions.public QueryRequest clearKeyConditionsEntries()
Returns a reference to this object so that method calls can be chained together.
public Map<String,Condition> getQueryFilter()
There is a newer parameter available. Use FilterExpression instead. Note that if you use QueryFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A condition that evaluates the query results and returns only the desired values.
If you specify more than one condition in the QueryFilter
map, then by default all of the conditions must evaluate to true. In
other words, the conditions are ANDed together. (You can use the
ConditionalOperator parameter to OR the conditions instead. If
you do this, then at least one of the conditions must evaluate to
true, rather than all of them.) QueryFilter does not
allow key attrbutes. You cannot define a filter condition on a hash
key or range key.
Each QueryFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator.
For type Number, value comparisons are numeric.
String value comparisons for
greater than, equals, or less than are based on ASCII character code
values. For example, a is greater than A,
and aa is greater than B. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE |
LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH
| IN | BETWEEN
For complete descriptions of all comparison operators, see API_Condition.html.
There is a newer parameter available. Use FilterExpression instead. Note that if you use QueryFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A condition that evaluates the query results and returns only the desired values.
If you specify more than one condition in the QueryFilter
map, then by default all of the conditions must evaluate to true. In
other words, the conditions are ANDed together. (You can use the
ConditionalOperator parameter to OR the conditions instead. If
you do this, then at least one of the conditions must evaluate to
true, rather than all of them.) QueryFilter does not
allow key attrbutes. You cannot define a filter condition on a hash
key or range key.
Each QueryFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator.
For type Number, value comparisons are numeric.
String value comparisons for
greater than, equals, or less than are based on ASCII character code
values. For example, a is greater than A,
and aa is greater than B. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE |
LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH
| IN | BETWEEN
For complete descriptions of all comparison operators, see API_Condition.html.
public void setQueryFilter(Map<String,Condition> queryFilter)
There is a newer parameter available. Use FilterExpression instead. Note that if you use QueryFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A condition that evaluates the query results and returns only the desired values.
If you specify more than one condition in the QueryFilter
map, then by default all of the conditions must evaluate to true. In
other words, the conditions are ANDed together. (You can use the
ConditionalOperator parameter to OR the conditions instead. If
you do this, then at least one of the conditions must evaluate to
true, rather than all of them.) QueryFilter does not
allow key attrbutes. You cannot define a filter condition on a hash
key or range key.
Each QueryFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator.
For type Number, value comparisons are numeric.
String value comparisons for
greater than, equals, or less than are based on ASCII character code
values. For example, a is greater than A,
and aa is greater than B. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE |
LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH
| IN | BETWEEN
For complete descriptions of all comparison operators, see API_Condition.html.
queryFilter - There is a newer parameter available. Use FilterExpression instead. Note that if you use QueryFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A condition that evaluates the query results and returns only the desired values.
If you specify more than one condition in the QueryFilter
map, then by default all of the conditions must evaluate to true. In
other words, the conditions are ANDed together. (You can use the
ConditionalOperator parameter to OR the conditions instead. If
you do this, then at least one of the conditions must evaluate to
true, rather than all of them.) QueryFilter does not
allow key attrbutes. You cannot define a filter condition on a hash
key or range key.
Each QueryFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator.
For type Number, value comparisons are numeric.
String value comparisons for
greater than, equals, or less than are based on ASCII character code
values. For example, a is greater than A,
and aa is greater than B. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE |
LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH
| IN | BETWEEN
For complete descriptions of all comparison operators, see API_Condition.html.
public QueryRequest withQueryFilter(Map<String,Condition> queryFilter)
There is a newer parameter available. Use FilterExpression instead. Note that if you use QueryFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A condition that evaluates the query results and returns only the desired values.
If you specify more than one condition in the QueryFilter
map, then by default all of the conditions must evaluate to true. In
other words, the conditions are ANDed together. (You can use the
ConditionalOperator parameter to OR the conditions instead. If
you do this, then at least one of the conditions must evaluate to
true, rather than all of them.) QueryFilter does not
allow key attrbutes. You cannot define a filter condition on a hash
key or range key.
Each QueryFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator.
For type Number, value comparisons are numeric.
String value comparisons for
greater than, equals, or less than are based on ASCII character code
values. For example, a is greater than A,
and aa is greater than B. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE |
LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH
| IN | BETWEEN
For complete descriptions of all comparison operators, see API_Condition.html.
Returns a reference to this object so that method calls can be chained together.
queryFilter - There is a newer parameter available. Use FilterExpression instead. Note that if you use QueryFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A condition that evaluates the query results and returns only the desired values.
If you specify more than one condition in the QueryFilter
map, then by default all of the conditions must evaluate to true. In
other words, the conditions are ANDed together. (You can use the
ConditionalOperator parameter to OR the conditions instead. If
you do this, then at least one of the conditions must evaluate to
true, rather than all of them.) QueryFilter does not
allow key attrbutes. You cannot define a filter condition on a hash
key or range key.
Each QueryFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator.
For type Number, value comparisons are numeric.
String value comparisons for
greater than, equals, or less than are based on ASCII character code
values. For example, a is greater than A,
and aa is greater than B. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE |
LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH
| IN | BETWEEN
For complete descriptions of all comparison operators, see API_Condition.html.
public QueryRequest addQueryFilterEntry(String key, Condition value)
There is a newer parameter available. Use FilterExpression instead. Note that if you use QueryFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A condition that evaluates the query results and returns only the desired values.
If you specify more than one condition in the QueryFilter
map, then by default all of the conditions must evaluate to true. In
other words, the conditions are ANDed together. (You can use the
ConditionalOperator parameter to OR the conditions instead. If
you do this, then at least one of the conditions must evaluate to
true, rather than all of them.) QueryFilter does not
allow key attrbutes. You cannot define a filter condition on a hash
key or range key.
Each QueryFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator.
For type Number, value comparisons are numeric.
String value comparisons for
greater than, equals, or less than are based on ASCII character code
values. For example, a is greater than A,
and aa is greater than B. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE |
LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH
| IN | BETWEEN
For complete descriptions of all comparison operators, see API_Condition.html.
The method adds a new key-value pair into QueryFilter parameter, and returns a reference to this object so that method calls can be chained together.
key - The key of the entry to be added into QueryFilter.value - The corresponding value of the entry to be added into QueryFilter.public QueryRequest clearQueryFilterEntries()
Returns a reference to this object so that method calls can be chained together.
public String getConditionalOperator()
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the QueryFilter map:
AND - If all of the
conditions evaluate to true, then the entire map evaluates to
true.
OR - If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is
the default.
The operation will succeed only if the entire map evaluates to true.
Constraints:
Allowed Values: AND, OR
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the QueryFilter map:
AND - If all of the
conditions evaluate to true, then the entire map evaluates to
true.
OR - If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is
the default.
The operation will succeed only if the entire map evaluates to true.
ConditionalOperatorpublic void setConditionalOperator(String conditionalOperator)
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the QueryFilter map:
AND - If all of the
conditions evaluate to true, then the entire map evaluates to
true.
OR - If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is
the default.
The operation will succeed only if the entire map evaluates to true.
Constraints:
Allowed Values: AND, OR
conditionalOperator - There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the QueryFilter map:
AND - If all of the
conditions evaluate to true, then the entire map evaluates to
true.
OR - If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is
the default.
The operation will succeed only if the entire map evaluates to true.
ConditionalOperatorpublic QueryRequest withConditionalOperator(String conditionalOperator)
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the QueryFilter map:
AND - If all of the
conditions evaluate to true, then the entire map evaluates to
true.
OR - If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is
the default.
The operation will succeed only if the entire map evaluates to true.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: AND, OR
conditionalOperator - There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the QueryFilter map:
AND - If all of the
conditions evaluate to true, then the entire map evaluates to
true.
OR - If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is
the default.
The operation will succeed only if the entire map evaluates to true.
ConditionalOperatorpublic void setConditionalOperator(ConditionalOperator conditionalOperator)
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the QueryFilter map:
AND - If all of the
conditions evaluate to true, then the entire map evaluates to
true.
OR - If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is
the default.
The operation will succeed only if the entire map evaluates to true.
Constraints:
Allowed Values: AND, OR
conditionalOperator - There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the QueryFilter map:
AND - If all of the
conditions evaluate to true, then the entire map evaluates to
true.
OR - If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is
the default.
The operation will succeed only if the entire map evaluates to true.
ConditionalOperatorpublic QueryRequest withConditionalOperator(ConditionalOperator conditionalOperator)
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the QueryFilter map:
AND - If all of the
conditions evaluate to true, then the entire map evaluates to
true.
OR - If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is
the default.
The operation will succeed only if the entire map evaluates to true.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: AND, OR
conditionalOperator - There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the QueryFilter map:
AND - If all of the
conditions evaluate to true, then the entire map evaluates to
true.
OR - If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is
the default.
The operation will succeed only if the entire map evaluates to true.
ConditionalOperatorpublic Boolean isScanIndexForward()
If ScanIndexForward is not specified, the results are returned in ascending order.
If ScanIndexForward is not specified, the results are returned in ascending order.
public void setScanIndexForward(Boolean scanIndexForward)
If ScanIndexForward is not specified, the results are returned in ascending order.
scanIndexForward - A value that specifies ascending (true) or descending (false)
traversal of the index. DynamoDB returns results reflecting the
requested order determined by the range key. If the data type is
Number, the results are returned in numeric order. For type String,
the results are returned in order of ASCII character code values. For
type Binary, DynamoDB treats each byte of the binary data as unsigned
when it compares binary values. If ScanIndexForward is not specified, the results are returned in ascending order.
public QueryRequest withScanIndexForward(Boolean scanIndexForward)
If ScanIndexForward is not specified, the results are returned in ascending order.
Returns a reference to this object so that method calls can be chained together.
scanIndexForward - A value that specifies ascending (true) or descending (false)
traversal of the index. DynamoDB returns results reflecting the
requested order determined by the range key. If the data type is
Number, the results are returned in numeric order. For type String,
the results are returned in order of ASCII character code values. For
type Binary, DynamoDB treats each byte of the binary data as unsigned
when it compares binary values. If ScanIndexForward is not specified, the results are returned in ascending order.
public Boolean getScanIndexForward()
If ScanIndexForward is not specified, the results are returned in ascending order.
If ScanIndexForward is not specified, the results are returned in ascending order.
public Map<String,AttributeValue> getExclusiveStartKey()
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
public void setExclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
exclusiveStartKey - The primary key of the first item that this operation will evaluate.
Use the value that was returned for LastEvaluatedKey in the
previous operation. The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
public QueryRequest withExclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
Returns a reference to this object so that method calls can be chained together.
exclusiveStartKey - The primary key of the first item that this operation will evaluate.
Use the value that was returned for LastEvaluatedKey in the
previous operation. The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
public void setExclusiveStartKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) throws IllegalArgumentException
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
This method accepts the hashKey, rangeKey of ExclusiveStartKey as
java.util.Map.Entry
hashKey - Primary hash key.rangeKey - Primary range key. (null if it a hash-only table)IllegalArgumentExceptionpublic QueryRequest withExclusiveStartKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) throws IllegalArgumentException
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
This method accepts the hashKey, rangeKey of ExclusiveStartKey as
java.util.Map.Entry
Returns a reference to this object so that method calls can be chained together.
hashKey - Primary hash key.rangeKey - Primary range key. (null if it a hash-only table)IllegalArgumentExceptionpublic QueryRequest addExclusiveStartKeyEntry(String key, AttributeValue value)
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
The method adds a new key-value pair into ExclusiveStartKey parameter, and returns a reference to this object so that method calls can be chained together.
key - The key of the entry to be added into ExclusiveStartKey.value - The corresponding value of the entry to be added into ExclusiveStartKey.public QueryRequest clearExclusiveStartKeyEntries()
Returns a reference to this object so that method calls can be chained together.
public String getReturnConsumedCapacity()
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.ReturnConsumedCapacitypublic void setReturnConsumedCapacity(String returnConsumedCapacity)
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity - A value that if set to TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.ReturnConsumedCapacitypublic QueryRequest withReturnConsumedCapacity(String returnConsumedCapacity)
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity - A value that if set to TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.ReturnConsumedCapacitypublic void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity - A value that if set to TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.ReturnConsumedCapacitypublic QueryRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity - A value that if set to TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.ReturnConsumedCapacitypublic String getProjectionExpression()
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.
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.
public void setProjectionExpression(String projectionExpression)
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.
projectionExpression - 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 will be returned. If any of the requested attributes are not found, they will not appear in the result.
public QueryRequest withProjectionExpression(String projectionExpression)
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.
Returns a reference to this object so that method calls can be chained together.
projectionExpression - 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 will be returned. If any of the requested attributes are not found, they will not appear in the result.
public String getFilterExpression()
The condition you specify is applied to the items queried; any items that do not match the expression are not returned.
The condition you specify is applied to the items queried; any items that do not match the expression are not returned.
public void setFilterExpression(String filterExpression)
The condition you specify is applied to the items queried; any items that do not match the expression are not returned.
filterExpression - A condition that 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.
public QueryRequest withFilterExpression(String filterExpression)
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.
filterExpression - A condition that 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.
public Map<String,String> getExpressionAttributeNames()
To shorten an attribute name that is very long or unwieldy in an expression.
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 expression:
order.customerInfo.LastName = "Smith" OR
order.customerInfo.LastName = "Jones"
Now suppose that you specified the following for ExpressionAttributeNames:
{"n":"order.customerInfo.LastName"}
The expression can now be simplified as follows:
#n = "Smith" OR #n = "Jones"
To shorten an attribute name that is very long or unwieldy in an expression.
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 expression:
order.customerInfo.LastName = "Smith" OR
order.customerInfo.LastName = "Jones"
Now suppose that you specified the following for ExpressionAttributeNames:
{"n":"order.customerInfo.LastName"}
The expression can now be simplified as follows:
#n = "Smith" OR #n = "Jones"
public void setExpressionAttributeNames(Map<String,String> expressionAttributeNames)
To shorten an attribute name that is very long or unwieldy in an expression.
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 expression:
order.customerInfo.LastName = "Smith" OR
order.customerInfo.LastName = "Jones"
Now suppose that you specified the following for ExpressionAttributeNames:
{"n":"order.customerInfo.LastName"}
The expression can now be simplified as follows:
#n = "Smith" OR #n = "Jones"
expressionAttributeNames - One or more substitution tokens for simplifying complex expressions.
The following are some use cases for an
ExpressionAttributeNames value: To shorten an attribute name that is very long or unwieldy in an expression.
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 expression:
order.customerInfo.LastName = "Smith" OR
order.customerInfo.LastName = "Jones"
Now suppose that you specified the following for ExpressionAttributeNames:
{"n":"order.customerInfo.LastName"}
The expression can now be simplified as follows:
#n = "Smith" OR #n = "Jones"
public QueryRequest withExpressionAttributeNames(Map<String,String> expressionAttributeNames)
To shorten an attribute name that is very long or unwieldy in an expression.
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 expression:
order.customerInfo.LastName = "Smith" OR
order.customerInfo.LastName = "Jones"
Now suppose that you specified the following for ExpressionAttributeNames:
{"n":"order.customerInfo.LastName"}
The expression can now be simplified as follows:
#n = "Smith" OR #n = "Jones"
Returns a reference to this object so that method calls can be chained together.
expressionAttributeNames - One or more substitution tokens for simplifying complex expressions.
The following are some use cases for an
ExpressionAttributeNames value: To shorten an attribute name that is very long or unwieldy in an expression.
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 expression:
order.customerInfo.LastName = "Smith" OR
order.customerInfo.LastName = "Jones"
Now suppose that you specified the following for ExpressionAttributeNames:
{"n":"order.customerInfo.LastName"}
The expression can now be simplified as follows:
#n = "Smith" OR #n = "Jones"
public QueryRequest addExpressionAttributeNamesEntry(String key, String value)
To shorten an attribute name that is very long or unwieldy in an expression.
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 expression:
order.customerInfo.LastName = "Smith" OR
order.customerInfo.LastName = "Jones"
Now suppose that you specified the following for ExpressionAttributeNames:
{"n":"order.customerInfo.LastName"}
The expression can now be simplified as follows:
#n = "Smith" OR #n = "Jones"
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.
key - The key of the entry to be added into ExpressionAttributeNames.value - The corresponding value of the entry to be added into ExpressionAttributeNames.public QueryRequest clearExpressionAttributeNamesEntries()
Returns a reference to this object so that method calls can be chained together.
public Map<String,AttributeValue> getExpressionAttributeValues()
Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN
("Available","Backordered","Discontinued")
Now suppose that you specified the following for ExpressionAttributeValues:
{
"a":{"S":"Available"}, "b":{"S":"Backordered"},
"d":{"S":"Discontinued"} }
The expression can now be simplified as follows:
ProductStatus IN
(:a,:b,:c)
Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN
("Available","Backordered","Discontinued")
Now suppose that you specified the following for ExpressionAttributeValues:
{
"a":{"S":"Available"}, "b":{"S":"Backordered"},
"d":{"S":"Discontinued"} }
The expression can now be simplified as follows:
ProductStatus IN
(:a,:b,:c)
public void setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN
("Available","Backordered","Discontinued")
Now suppose that you specified the following for ExpressionAttributeValues:
{
"a":{"S":"Available"}, "b":{"S":"Backordered"},
"d":{"S":"Discontinued"} }
The expression can now be simplified as follows:
ProductStatus IN
(:a,:b,:c)
expressionAttributeValues - One or more values that can be substituted in an expression. Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN
("Available","Backordered","Discontinued")
Now suppose that you specified the following for ExpressionAttributeValues:
{
"a":{"S":"Available"}, "b":{"S":"Backordered"},
"d":{"S":"Discontinued"} }
The expression can now be simplified as follows:
ProductStatus IN
(:a,:b,:c)
public QueryRequest withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN
("Available","Backordered","Discontinued")
Now suppose that you specified the following for ExpressionAttributeValues:
{
"a":{"S":"Available"}, "b":{"S":"Backordered"},
"d":{"S":"Discontinued"} }
The expression can now be simplified as follows:
ProductStatus IN
(:a,:b,:c)
Returns a reference to this object so that method calls can be chained together.
expressionAttributeValues - One or more values that can be substituted in an expression. Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN
("Available","Backordered","Discontinued")
Now suppose that you specified the following for ExpressionAttributeValues:
{
"a":{"S":"Available"}, "b":{"S":"Backordered"},
"d":{"S":"Discontinued"} }
The expression can now be simplified as follows:
ProductStatus IN
(:a,:b,:c)
public QueryRequest addExpressionAttributeValuesEntry(String key, AttributeValue value)
Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN
("Available","Backordered","Discontinued")
Now suppose that you specified the following for ExpressionAttributeValues:
{
"a":{"S":"Available"}, "b":{"S":"Backordered"},
"d":{"S":"Discontinued"} }
The expression can now be simplified as follows:
ProductStatus IN
(:a,:b,:c)
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.
key - The key of the entry to be added into ExpressionAttributeValues.value - The corresponding value of the entry to be added into ExpressionAttributeValues.public QueryRequest clearExpressionAttributeValuesEntries()
Returns a reference to this object so that method calls can be chained together.
public String toString()
toString in class ObjectObject.toString()Copyright © 2015. All rights reserved.