public class QueryRequest extends 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 read capacity units according to the type of read.
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 a LastEvaluatedKey to continue the query in a subsequent operation. Unlike a Scan operation, a Query operation never returns an empty result set and a LastEvaluatedKey . The LastEvaluatedKey is only provided if the results exceed 1 MB, or if you have used Limit .
To request a strongly consistent result, set ConsistentRead to true.
| 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 |
addKeyConditionsEntry(String key,
Condition value)
The selection criteria for the query.
|
QueryRequest |
clearExclusiveStartKeyEntries()
Removes all the entries added into ExclusiveStartKey.
|
QueryRequest |
clearKeyConditionsEntries()
Removes all the entries added into KeyConditions.
|
boolean |
equals(Object obj) |
List<String> |
getAttributesToGet()
The names of one or more attributes to retrieve.
|
Boolean |
getConsistentRead()
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.
|
String |
getIndexName()
The name of an index on the table 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 |
getReturnConsumedCapacity()
If set to
TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included. |
Boolean |
getScanIndexForward()
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()
If set to
true, then the operation uses strongly
consistent reads; otherwise, eventually consistent reads are used. |
Boolean |
isScanIndexForward()
Specifies ascending (true) or descending (false) traversal of the
index.
|
void |
setAttributesToGet(Collection<String> attributesToGet)
The names of one or more attributes to retrieve.
|
void |
setConsistentRead(Boolean consistentRead)
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 |
setIndexName(String indexName)
The name of an index on the table 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 |
setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
If set to
TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included. |
void |
setReturnConsumedCapacity(String returnConsumedCapacity)
If set to
TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included. |
void |
setScanIndexForward(Boolean scanIndexForward)
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)
The names of one or more attributes to retrieve.
|
QueryRequest |
withAttributesToGet(String... attributesToGet)
The names of one or more attributes to retrieve.
|
QueryRequest |
withConsistentRead(Boolean consistentRead)
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 |
withIndexName(String indexName)
The name of an index on the table 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 |
withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
If set to
TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included. |
QueryRequest |
withReturnConsumedCapacity(String returnConsumedCapacity)
If set to
TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included. |
QueryRequest |
withScanIndexForward(Boolean scanIndexForward)
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.
|
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, 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 on the table to query.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 on the table to query.public String getSelect()
ALL_ATTRIBUTES: Returns all of
the item attributes. For a table, this is the default. For an index,
this mode causes Amazon DynamoDB to fetch the full item from the table
for each matching item in the index. If the index is configured to
project all item attributes, the matching items will not be fetched
from the table. Fetching items from the table incurs additional
throughput cost and latency.
ALL_PROJECTED_ATTRIBUTES: Allowed only when querying
an index. Retrieves all attributes which have been projected into the
index. If the index is configured to project all attributes, this 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 is equivalent to specifying
AttributesToGet without specifying any value for Select.
If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
When neither Select nor
AttributesToGet are specified, Amazon 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. For a table, this is the default. For an index,
this mode causes Amazon DynamoDB to fetch the full item from the table
for each matching item in the index. If the index is configured to
project all item attributes, the matching items will not be fetched
from the table. Fetching items from the table incurs additional
throughput cost and latency.
ALL_PROJECTED_ATTRIBUTES: Allowed only when querying
an index. Retrieves all attributes which have been projected into the
index. If the index is configured to project all attributes, this 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 is equivalent to specifying
AttributesToGet without specifying any value for Select.
If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
When neither Select nor
AttributesToGet are specified, Amazon 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. For a table, this is the default. For an index,
this mode causes Amazon DynamoDB to fetch the full item from the table
for each matching item in the index. If the index is configured to
project all item attributes, the matching items will not be fetched
from the table. Fetching items from the table incurs additional
throughput cost and latency.
ALL_PROJECTED_ATTRIBUTES: Allowed only when querying
an index. Retrieves all attributes which have been projected into the
index. If the index is configured to project all attributes, this 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 is equivalent to specifying
AttributesToGet without specifying any value for Select.
If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
When neither Select nor
AttributesToGet are specified, Amazon 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. For a table, this is the default. For an index,
this mode causes Amazon DynamoDB to fetch the full item from the table
for each matching item in the index. If the index is configured to
project all item attributes, the matching items will not be fetched
from the table. Fetching items from the table incurs additional
throughput cost and latency.
ALL_PROJECTED_ATTRIBUTES: Allowed only when querying
an index. Retrieves all attributes which have been projected into the
index. If the index is configured to project all attributes, this 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 is equivalent to specifying
AttributesToGet without specifying any value for Select.
If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
When neither Select nor
AttributesToGet are specified, Amazon 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. For a table, this is the default. For an index,
this mode causes Amazon DynamoDB to fetch the full item from the table
for each matching item in the index. If the index is configured to
project all item attributes, the matching items will not be fetched
from the table. Fetching items from the table incurs additional
throughput cost and latency.
ALL_PROJECTED_ATTRIBUTES: Allowed only when querying
an index. Retrieves all attributes which have been projected into the
index. If the index is configured to project all attributes, this 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 is equivalent to specifying
AttributesToGet without specifying any value for Select.
If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
When neither Select nor
AttributesToGet are specified, Amazon 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. For a table, this is the default. For an index,
this mode causes Amazon DynamoDB to fetch the full item from the table
for each matching item in the index. If the index is configured to
project all item attributes, the matching items will not be fetched
from the table. Fetching items from the table incurs additional
throughput cost and latency.
ALL_PROJECTED_ATTRIBUTES: Allowed only when querying
an index. Retrieves all attributes which have been projected into the
index. If the index is configured to project all attributes, this 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 is equivalent to specifying
AttributesToGet without specifying any value for Select.
If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
When neither Select nor
AttributesToGet are specified, Amazon 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. For a table, this is the default. For an index,
this mode causes Amazon DynamoDB to fetch the full item from the table
for each matching item in the index. If the index is configured to
project all item attributes, the matching items will not be fetched
from the table. Fetching items from the table incurs additional
throughput cost and latency.
ALL_PROJECTED_ATTRIBUTES: Allowed only when querying
an index. Retrieves all attributes which have been projected into the
index. If the index is configured to project all attributes, this 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 is equivalent to specifying
AttributesToGet without specifying any value for Select.
If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
When neither Select nor
AttributesToGet are specified, Amazon 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. For a table, this is the default. For an index,
this mode causes Amazon DynamoDB to fetch the full item from the table
for each matching item in the index. If the index is configured to
project all item attributes, the matching items will not be fetched
from the table. Fetching items from the table incurs additional
throughput cost and latency.
ALL_PROJECTED_ATTRIBUTES: Allowed only when querying
an index. Retrieves all attributes which have been projected into the
index. If the index is configured to project all attributes, this 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 is equivalent to specifying
AttributesToGet without specifying any value for Select.
If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
When neither Select nor
AttributesToGet are specified, Amazon 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. For a table, this is the default. For an index,
this mode causes Amazon DynamoDB to fetch the full item from the table
for each matching item in the index. If the index is configured to
project all item attributes, the matching items will not be fetched
from the table. Fetching items from the table incurs additional
throughput cost and latency.
ALL_PROJECTED_ATTRIBUTES: Allowed only when querying
an index. Retrieves all attributes which have been projected into the
index. If the index is configured to project all attributes, this 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 is equivalent to specifying
AttributesToGet without specifying any value for Select.
If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
When neither Select nor
AttributesToGet are specified, Amazon 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. For a table, this is the default. For an index,
this mode causes Amazon DynamoDB to fetch the full item from the table
for each matching item in the index. If the index is configured to
project all item attributes, the matching items will not be fetched
from the table. Fetching items from the table incurs additional
throughput cost and latency.
ALL_PROJECTED_ATTRIBUTES: Allowed only when querying
an index. Retrieves all attributes which have been projected into the
index. If the index is configured to project all attributes, this 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 is equivalent to specifying
AttributesToGet without specifying any value for Select.
If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
When neither Select nor
AttributesToGet are specified, Amazon 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()
If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
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.)
Constraints:
Length: 1 -
If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
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.)
public void setAttributesToGet(Collection<String> attributesToGet)
If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
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.)
Constraints:
Length: 1 -
attributesToGet - 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. If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
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.)
public QueryRequest withAttributesToGet(String... attributesToGet)
If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
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.)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 -
attributesToGet - 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. If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
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.)
public QueryRequest withAttributesToGet(Collection<String> attributesToGet)
If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
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.)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 -
attributesToGet - 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. If you are querying an 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 index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.
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.)
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 Amazon 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
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 Amazon DynamoDB reaches this limit, it stops
the operation and returns the matching values up to the limit, and a
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 Amazon 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
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 Amazon DynamoDB reaches this limit, it stops
the operation and returns the matching values up to the limit, and a
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.true, then the operation uses strongly
consistent reads; otherwise, eventually consistent reads are used.public void setConsistentRead(Boolean consistentRead)
true, then the operation uses strongly
consistent reads; otherwise, eventually consistent reads are used.consistentRead - If set to true, then the operation uses strongly
consistent reads; otherwise, eventually consistent reads are used.public QueryRequest withConsistentRead(Boolean consistentRead)
true, then the operation uses strongly
consistent reads; otherwise, eventually consistent reads are used.
Returns a reference to this object so that method calls can be chained together.
consistentRead - If set to true, then the operation uses strongly
consistent reads; otherwise, eventually consistent reads are used.public Boolean getConsistentRead()
true, then the operation uses strongly
consistent reads; otherwise, eventually consistent reads are used.true, then the operation uses strongly
consistent reads; otherwise, eventually consistent reads are used.public Map<String,Condition> getKeyConditions()
For a query on a table, you
can only have conditions 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 a secondary index, you can only have conditions 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.
Multiple conditions are evaluated using "AND"; in other words, all of the conditions must be met in order for an item to appear in the results results.
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. This list contains exactly one value,
except for a 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, For Binary, Amazon DynamoDB treats each byte of the binary data as
unsigned when it compares binary values, for example when evaluating
query expressions. BETWEEN or IN comparison, in
which case the list contains two values. 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.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
Valid comparison operators for Query:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
The following are descriptions of each comparison operator.
EQ : Equal.
AttributeValueList can contain
only one AttributeValue of type String, Number, or Binary (not
a set). If an item contains an AttributeValue 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 of type String, Number, or Binary (not a
set). If an item contains an AttributeValue 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).
If an item contains an AttributeValue 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue 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). The target attribute of the comparison must be a String or Binary (not a Number or a set).
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). 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 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 a query on a table, you
can only have conditions 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 a secondary index, you can only have conditions 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.
Multiple conditions are evaluated using "AND"; in other words, all of the conditions must be met in order for an item to appear in the results results.
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. This list contains exactly one value,
except for a 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, For Binary, Amazon DynamoDB treats each byte of the binary data as
unsigned when it compares binary values, for example when evaluating
query expressions. BETWEEN or IN comparison, in
which case the list contains two values. 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.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
Valid comparison operators for Query:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
The following are descriptions of each comparison operator.
EQ : Equal.
AttributeValueList can contain
only one AttributeValue of type String, Number, or Binary (not
a set). If an item contains an AttributeValue 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 of type String, Number, or Binary (not a
set). If an item contains an AttributeValue 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).
If an item contains an AttributeValue 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue 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). The target attribute of the comparison must be a String or Binary (not a Number or a set).
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). 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 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"]}
public void setKeyConditions(Map<String,Condition> keyConditions)
For a query on a table, you
can only have conditions 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 a secondary index, you can only have conditions 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.
Multiple conditions are evaluated using "AND"; in other words, all of the conditions must be met in order for an item to appear in the results results.
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. This list contains exactly one value,
except for a 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, For Binary, Amazon DynamoDB treats each byte of the binary data as
unsigned when it compares binary values, for example when evaluating
query expressions. BETWEEN or IN comparison, in
which case the list contains two values. 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.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
Valid comparison operators for Query:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
The following are descriptions of each comparison operator.
EQ : Equal.
AttributeValueList can contain
only one AttributeValue of type String, Number, or Binary (not
a set). If an item contains an AttributeValue 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 of type String, Number, or Binary (not a
set). If an item contains an AttributeValue 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).
If an item contains an AttributeValue 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue 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). The target attribute of the comparison must be a String or Binary (not a Number or a set).
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). 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 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"]}
keyConditions - The selection criteria for the query. For a query on a table, you
can only have conditions 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 a secondary index, you can only have conditions 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.
Multiple conditions are evaluated using "AND"; in other words, all of the conditions must be met in order for an item to appear in the results results.
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. This list contains exactly one value,
except for a 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, For Binary, Amazon DynamoDB treats each byte of the binary data as
unsigned when it compares binary values, for example when evaluating
query expressions. BETWEEN or IN comparison, in
which case the list contains two values. 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.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
Valid comparison operators for Query:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
The following are descriptions of each comparison operator.
EQ : Equal.
AttributeValueList can contain
only one AttributeValue of type String, Number, or Binary (not
a set). If an item contains an AttributeValue 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 of type String, Number, or Binary (not a
set). If an item contains an AttributeValue 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).
If an item contains an AttributeValue 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue 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). The target attribute of the comparison must be a String or Binary (not a Number or a set).
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). 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 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"]}
public QueryRequest withKeyConditions(Map<String,Condition> keyConditions)
For a query on a table, you
can only have conditions 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 a secondary index, you can only have conditions 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.
Multiple conditions are evaluated using "AND"; in other words, all of the conditions must be met in order for an item to appear in the results results.
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. This list contains exactly one value,
except for a 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, For Binary, Amazon DynamoDB treats each byte of the binary data as
unsigned when it compares binary values, for example when evaluating
query expressions. BETWEEN or IN comparison, in
which case the list contains two values. 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.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
Valid comparison operators for Query:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
The following are descriptions of each comparison operator.
EQ : Equal.
AttributeValueList can contain
only one AttributeValue of type String, Number, or Binary (not
a set). If an item contains an AttributeValue 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 of type String, Number, or Binary (not a
set). If an item contains an AttributeValue 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).
If an item contains an AttributeValue 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue 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). The target attribute of the comparison must be a String or Binary (not a Number or a set).
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). 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 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"]}
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 only have conditions 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 a secondary index, you can only have conditions 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.
Multiple conditions are evaluated using "AND"; in other words, all of the conditions must be met in order for an item to appear in the results results.
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. This list contains exactly one value,
except for a 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, For Binary, Amazon DynamoDB treats each byte of the binary data as
unsigned when it compares binary values, for example when evaluating
query expressions. BETWEEN or IN comparison, in
which case the list contains two values. 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.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
Valid comparison operators for Query:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
The following are descriptions of each comparison operator.
EQ : Equal.
AttributeValueList can contain
only one AttributeValue of type String, Number, or Binary (not
a set). If an item contains an AttributeValue 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 of type String, Number, or Binary (not a
set). If an item contains an AttributeValue 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).
If an item contains an AttributeValue 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue 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). The target attribute of the comparison must be a String or Binary (not a Number or a set).
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). 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 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"]}
public QueryRequest addKeyConditionsEntry(String key, Condition value)
For a query on a table, you
can only have conditions 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 a secondary index, you can only have conditions 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.
Multiple conditions are evaluated using "AND"; in other words, all of the conditions must be met in order for an item to appear in the results results.
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. This list contains exactly one value,
except for a 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, For Binary, Amazon DynamoDB treats each byte of the binary data as
unsigned when it compares binary values, for example when evaluating
query expressions. BETWEEN or IN comparison, in
which case the list contains two values. 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.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
Valid comparison operators for Query:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
The following are descriptions of each comparison operator.
EQ : Equal.
AttributeValueList can contain
only one AttributeValue of type String, Number, or Binary (not
a set). If an item contains an AttributeValue 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 of type String, Number, or Binary (not a
set). If an item contains an AttributeValue 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).
If an item contains an AttributeValue 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue 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). The target attribute of the comparison must be a String or Binary (not a Number or a set).
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). 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 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"]}
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 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 - Specifies ascending (true) or descending (false) traversal of the
index. Amazon 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 String, the results are returned in
order of ASCII character code values. For Binary, Amazon 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 - Specifies ascending (true) or descending (false) traversal of the
index. Amazon 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 String, the results are returned in
order of ASCII character code values. For Binary, Amazon 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, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included.ReturnConsumedCapacitypublic void setReturnConsumedCapacity(String returnConsumedCapacity)
TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
returnConsumedCapacity - If set to TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included.ReturnConsumedCapacitypublic QueryRequest withReturnConsumedCapacity(String returnConsumedCapacity)
TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: TOTAL, NONE
returnConsumedCapacity - If set to TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included.ReturnConsumedCapacitypublic void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included.
Constraints:
Allowed Values: TOTAL, NONE
returnConsumedCapacity - If set to TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included.ReturnConsumedCapacitypublic QueryRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: TOTAL, NONE
returnConsumedCapacity - If set to TOTAL, ConsumedCapacity is included in
the response; if set to NONE (the default),
ConsumedCapacity is not included.ReturnConsumedCapacitypublic String toString()
toString in class ObjectObject.toString()Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.