public class QueryResult extends Object implements Serializable
Represents the output of a Query operation.
Constructor and Description |
---|
QueryResult() |
Modifier and Type | Method and Description |
---|---|
QueryResult |
addLastEvaluatedKeyEntry(String key,
AttributeValue value)
The primary key of the item where the operation stopped, inclusive of
the previous result set.
|
QueryResult |
clearLastEvaluatedKeyEntries()
Removes all the entries added into LastEvaluatedKey.
|
boolean |
equals(Object obj) |
ConsumedCapacity |
getConsumedCapacity()
The table name that consumed provisioned throughput, and the number of
capacity units consumed by it.
|
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.
|
int |
hashCode() |
void |
setConsumedCapacity(ConsumedCapacity consumedCapacity)
The table name that consumed provisioned throughput, and the number of
capacity units consumed by it.
|
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.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
QueryResult |
withConsumedCapacity(ConsumedCapacity consumedCapacity)
The table name that consumed provisioned throughput, and the number of
capacity units consumed by it.
|
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.
|
public List<Map<String,AttributeValue>> getItems()
public void setItems(Collection<Map<String,AttributeValue>> items)
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)
Returns a reference to this object so that method calls can be chained together.
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)
Returns a reference to this object so that method calls can be chained together.
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 Integer getCount()
public void setCount(Integer count)
count
- The number of items in the response.public QueryResult withCount(Integer count)
Returns a reference to this object so that method calls can be chained together.
count
- The number of items in the response.public Map<String,AttributeValue> getLastEvaluatedKey()
LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).
LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).
public void setLastEvaluatedKey(Map<String,AttributeValue> lastEvaluatedKey)
LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).
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. LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).
public QueryResult withLastEvaluatedKey(Map<String,AttributeValue> lastEvaluatedKey)
LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).
Returns a reference to this object so that method calls can be chained together.
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. LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).
public QueryResult addLastEvaluatedKeyEntry(String key, AttributeValue value)
LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).
The method adds a new key-value pair into LastEvaluatedKey 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 LastEvaluatedKey.value
- The corresponding value of the entry to be added into LastEvaluatedKey.public QueryResult clearLastEvaluatedKeyEntries()
Returns a reference to this object so that method calls can be chained together.
public ConsumedCapacity getConsumedCapacity()
public void setConsumedCapacity(ConsumedCapacity consumedCapacity)
consumedCapacity
- The table name that consumed provisioned throughput, and the number of
capacity units consumed by it. ConsumedCapacity is only
returned if it was asked for in the request. For more information, see
Provisioned
Throughput in the Amazon DynamoDB Developer Guide.public QueryResult withConsumedCapacity(ConsumedCapacity consumedCapacity)
Returns a reference to this object so that method calls can be chained together.
consumedCapacity
- The table name that consumed provisioned throughput, and the number of
capacity units consumed by it. ConsumedCapacity is only
returned if it was asked for in the request. For more information, see
Provisioned
Throughput in the Amazon DynamoDB Developer Guide.public String toString()
toString
in class Object
Object.toString()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.