@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class QueryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Represents the output of a Query
operation.
Constructor and Description |
---|
QueryResult() |
Modifier and Type | Method and Description |
---|---|
QueryResult |
addLastEvaluatedKeyEntry(String key,
AttributeValue value) |
QueryResult |
clearLastEvaluatedKeyEntries()
Removes all the entries added into LastEvaluatedKey.
|
QueryResult |
clone() |
boolean |
equals(Object obj) |
ConsumedCapacity |
getConsumedCapacity()
The capacity units consumed by the
Query operation. |
Integer |
getCount()
The number of items in the response.
|
List<Map<String,AttributeValue>> |
getItems()
An array of item attributes that match the query criteria.
|
Map<String,AttributeValue> |
getLastEvaluatedKey()
The primary key of the item where the operation stopped, inclusive of the previous result set.
|
Integer |
getScannedCount()
The number of items evaluated, before any
QueryFilter is applied. |
int |
hashCode() |
void |
setConsumedCapacity(ConsumedCapacity consumedCapacity)
The capacity units consumed by the
Query operation. |
void |
setCount(Integer count)
The number of items in the response.
|
void |
setItems(Collection<Map<String,AttributeValue>> items)
An array of item attributes that match the query criteria.
|
void |
setLastEvaluatedKey(Map<String,AttributeValue> lastEvaluatedKey)
The primary key of the item where the operation stopped, inclusive of the previous result set.
|
void |
setScannedCount(Integer scannedCount)
The number of items evaluated, before any
QueryFilter is applied. |
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
QueryResult |
withConsumedCapacity(ConsumedCapacity consumedCapacity)
The capacity units consumed by the
Query operation. |
QueryResult |
withCount(Integer count)
The number of items in the response.
|
QueryResult |
withItems(Collection<Map<String,AttributeValue>> items)
An array of item attributes that match the query criteria.
|
QueryResult |
withItems(Map<String,AttributeValue>... items)
An array of item attributes that match the query criteria.
|
QueryResult |
withLastEvaluatedKey(Map<String,AttributeValue> lastEvaluatedKey)
The primary key of the item where the operation stopped, inclusive of the previous result set.
|
QueryResult |
withScannedCount(Integer scannedCount)
The number of items evaluated, before any
QueryFilter is applied. |
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public List<Map<String,AttributeValue>> getItems()
An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.
public void setItems(Collection<Map<String,AttributeValue>> items)
An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.
items
- An array of item attributes that match the query criteria. Each element in this array consists of an
attribute name and the value for that attribute.public QueryResult withItems(Map<String,AttributeValue>... items)
An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.
NOTE: This method appends the values to the existing list (if any). Use
setItems(java.util.Collection)
or withItems(java.util.Collection)
if you want to override the
existing values.
items
- An array of item attributes that match the query criteria. Each element in this array consists of an
attribute name and the value for that attribute.public QueryResult withItems(Collection<Map<String,AttributeValue>> items)
An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.
items
- An array of item attributes that match the query criteria. Each element in this array consists of an
attribute name and the value for that attribute.public void setCount(Integer count)
The number of items in the response.
If you used a QueryFilter
in the request, then Count
is the number of items returned
after the filter was applied, and ScannedCount
is the number of matching items before the filter was
applied.
If you did not use a filter in the request, then Count
and ScannedCount
are the same.
count
- The number of items in the response.
If you used a QueryFilter
in the request, then Count
is the number of items
returned after the filter was applied, and ScannedCount
is the number of matching items
before the filter was applied.
If you did not use a filter in the request, then Count
and ScannedCount
are the
same.
public Integer getCount()
The number of items in the response.
If you used a QueryFilter
in the request, then Count
is the number of items returned
after the filter was applied, and ScannedCount
is the number of matching items before the filter was
applied.
If you did not use a filter in the request, then Count
and ScannedCount
are the same.
If you used a QueryFilter
in the request, then Count
is the number of items
returned after the filter was applied, and ScannedCount
is the number of matching items
before the filter was applied.
If you did not use a filter in the request, then Count
and ScannedCount
are the
same.
public QueryResult withCount(Integer count)
The number of items in the response.
If you used a QueryFilter
in the request, then Count
is the number of items returned
after the filter was applied, and ScannedCount
is the number of matching items before the filter was
applied.
If you did not use a filter in the request, then Count
and ScannedCount
are the same.
count
- The number of items in the response.
If you used a QueryFilter
in the request, then Count
is the number of items
returned after the filter was applied, and ScannedCount
is the number of matching items
before the filter was applied.
If you did not use a filter in the request, then Count
and ScannedCount
are the
same.
public void setScannedCount(Integer scannedCount)
The number of items evaluated, before any QueryFilter
is applied. A high ScannedCount
value with few, or no, Count
results indicates an inefficient Query
operation. For more
information, see Count and
ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount
is the same as Count
.
scannedCount
- The number of items evaluated, before any QueryFilter
is applied. A high
ScannedCount
value with few, or no, Count
results indicates an inefficient
Query
operation. For more information, see Count and
ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount
is the same as
Count
.
public Integer getScannedCount()
The number of items evaluated, before any QueryFilter
is applied. A high ScannedCount
value with few, or no, Count
results indicates an inefficient Query
operation. For more
information, see Count and
ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount
is the same as Count
.
QueryFilter
is applied. A high
ScannedCount
value with few, or no, Count
results indicates an inefficient
Query
operation. For more information, see Count and
ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount
is the same as
Count
.
public QueryResult withScannedCount(Integer scannedCount)
The number of items evaluated, before any QueryFilter
is applied. A high ScannedCount
value with few, or no, Count
results indicates an inefficient Query
operation. For more
information, see Count and
ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount
is the same as Count
.
scannedCount
- The number of items evaluated, before any QueryFilter
is applied. A high
ScannedCount
value with few, or no, Count
results indicates an inefficient
Query
operation. For more information, see Count and
ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount
is the same as
Count
.
public Map<String,AttributeValue> getLastEvaluatedKey()
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedKey
is empty, then the "last page" of results has been processed and there is no
more data to be retrieved.
If LastEvaluatedKey
is not empty, it does not necessarily mean that there is more data in the result
set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey
is empty.
If LastEvaluatedKey
is empty, then the "last page" of results has been processed and there
is no more data to be retrieved.
If LastEvaluatedKey
is not empty, it does not necessarily mean that there is more data in
the result set. The only way to know when you have reached the end of the result set is when
LastEvaluatedKey
is empty.
public void setLastEvaluatedKey(Map<String,AttributeValue> lastEvaluatedKey)
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedKey
is empty, then the "last page" of results has been processed and there is no
more data to be retrieved.
If LastEvaluatedKey
is not empty, it does not necessarily mean that there is more data in the result
set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey
is empty.
lastEvaluatedKey
- The primary key of the item where the operation stopped, inclusive of the previous result set. Use this
value to start a new operation, excluding this value in the new request.
If LastEvaluatedKey
is empty, then the "last page" of results has been processed and there is
no more data to be retrieved.
If LastEvaluatedKey
is not empty, it does not necessarily mean that there is more data in the
result set. The only way to know when you have reached the end of the result set is when
LastEvaluatedKey
is empty.
public QueryResult withLastEvaluatedKey(Map<String,AttributeValue> lastEvaluatedKey)
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedKey
is empty, then the "last page" of results has been processed and there is no
more data to be retrieved.
If LastEvaluatedKey
is not empty, it does not necessarily mean that there is more data in the result
set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey
is empty.
lastEvaluatedKey
- The primary key of the item where the operation stopped, inclusive of the previous result set. Use this
value to start a new operation, excluding this value in the new request.
If LastEvaluatedKey
is empty, then the "last page" of results has been processed and there is
no more data to be retrieved.
If LastEvaluatedKey
is not empty, it does not necessarily mean that there is more data in the
result set. The only way to know when you have reached the end of the result set is when
LastEvaluatedKey
is empty.
public QueryResult addLastEvaluatedKeyEntry(String key, AttributeValue value)
public QueryResult clearLastEvaluatedKeyEntries()
public void setConsumedCapacity(ConsumedCapacity consumedCapacity)
The capacity units consumed by the Query
operation. The data returned includes the total provisioned
throughput consumed, along with statistics for the table and any indexes involved in the operation.
ConsumedCapacity
is only returned if the ReturnConsumedCapacity
parameter was specified
For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
consumedCapacity
- The capacity units consumed by the Query
operation. The data returned includes the total
provisioned throughput consumed, along with statistics for the table and any indexes involved in the
operation. ConsumedCapacity
is only returned if the ReturnConsumedCapacity
parameter was specified For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.public ConsumedCapacity getConsumedCapacity()
The capacity units consumed by the Query
operation. The data returned includes the total provisioned
throughput consumed, along with statistics for the table and any indexes involved in the operation.
ConsumedCapacity
is only returned if the ReturnConsumedCapacity
parameter was specified
For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
Query
operation. The data returned includes the total
provisioned throughput consumed, along with statistics for the table and any indexes involved in the
operation. ConsumedCapacity
is only returned if the ReturnConsumedCapacity
parameter was specified For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.public QueryResult withConsumedCapacity(ConsumedCapacity consumedCapacity)
The capacity units consumed by the Query
operation. The data returned includes the total provisioned
throughput consumed, along with statistics for the table and any indexes involved in the operation.
ConsumedCapacity
is only returned if the ReturnConsumedCapacity
parameter was specified
For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
consumedCapacity
- The capacity units consumed by the Query
operation. The data returned includes the total
provisioned throughput consumed, along with statistics for the table and any indexes involved in the
operation. ConsumedCapacity
is only returned if the ReturnConsumedCapacity
parameter was specified For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.public String toString()
toString
in class Object
Object.toString()
public QueryResult clone()
Copyright © 2018. All rights reserved.