Did this page help you?

   Yes   No   Tell us about it...

com.amazonaws.services.dynamodbv2.model
Class QueryResult

java.lang.Object
  extended by com.amazonaws.services.dynamodbv2.model.QueryResult
All Implemented Interfaces:
Serializable

public class QueryResult
extends Object
implements Serializable

Represents the output of a Query operation.

See Also:
Serialized Form

Constructor Summary
QueryResult()
           
 
Method Summary
 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.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

QueryResult

public QueryResult()
Method Detail

getItems

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.

Returns:
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.

setItems

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.

Parameters:
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.

withItems

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:
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.
Returns:
A reference to this updated object so that method calls can be chained together.

withItems

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:
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.
Returns:
A reference to this updated object so that method calls can be chained together.

getCount

public Integer getCount()
The number of items in the response.

Returns:
The number of items in the response.

setCount

public void setCount(Integer count)
The number of items in the response.

Parameters:
count - The number of items in the response.

withCount

public QueryResult withCount(Integer count)
The number of items in the response.

Returns a reference to this object so that method calls can be chained together.

Parameters:
count - The number of items in the response.
Returns:
A reference to this updated object so that method calls can be chained together.

getLastEvaluatedKey

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.

LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).

Returns:
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).


setLastEvaluatedKey

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.

LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).

Parameters:
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).


withLastEvaluatedKey

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.

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.

Parameters:
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).

Returns:
A reference to this updated object so that method calls can be chained together.

getConsumedCapacity

public ConsumedCapacity getConsumedCapacity()
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.

Returns:
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.

setConsumedCapacity

public void setConsumedCapacity(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.

Parameters:
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.

withConsumedCapacity

public QueryResult withConsumedCapacity(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.

Returns a reference to this object so that method calls can be chained together.

Parameters:
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.
Returns:
A reference to this updated object so that method calls can be chained together.

toString

public String toString()
Returns a string representation of this object; useful for testing and debugging.

Overrides:
toString in class Object
Returns:
A string representation of this object.
See Also:
Object.toString()

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.