QueryResult (AWS SDK for Java

java.lang.Object
- 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

Constructors
Constructor and Description

QueryResult()

Constructors
Constructor and Description
`QueryResult()`

Method Summary

Methods
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()` Represents the capacity units consumed by an 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.
`int`	`hashCode()`
`void`	`setConsumedCapacity(ConsumedCapacity consumedCapacity)` Represents the capacity units consumed by an 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.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`QueryResult`	`withConsumedCapacity(ConsumedCapacity consumedCapacity)` Represents the capacity units consumed by an 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.

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.
    If LastEvaluatedKey is null, then the "last page" of results has been processed and there is no more data to be retrieved.
    If LastEvaluatedKey is anything other than null, this 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 null.
    
    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.
    If LastEvaluatedKey is null, then the "last page" of results has been processed and there is no more data to be retrieved.
    If LastEvaluatedKey is anything other than null, this 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 null.
  - 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.
    If LastEvaluatedKey is null, then the "last page" of results has been processed and there is no more data to be retrieved.
    If LastEvaluatedKey is anything other than null, this 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 null.
    
    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.
    If LastEvaluatedKey is null, then the "last page" of results has been processed and there is no more data to be retrieved.
    If LastEvaluatedKey is anything other than null, this 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 null.
  - 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.
    If LastEvaluatedKey is null, then the "last page" of results has been processed and there is no more data to be retrieved.
    If LastEvaluatedKey is anything other than null, this 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 null.
    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.
    If LastEvaluatedKey is null, then the "last page" of results has been processed and there is no more data to be retrieved.
    If LastEvaluatedKey is anything other than null, this 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 null.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - addLastEvaluatedKeyEntry
```
public QueryResult addLastEvaluatedKeyEntry(String key,
                                   AttributeValue value)
```
    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 null, then the "last page" of results has been processed and there is no more data to be retrieved.
    If LastEvaluatedKey is anything other than null, this 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 null.
    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.
    
    Parameters:
    key - The key of the entry to be added into LastEvaluatedKey.
    value - The corresponding value of the entry to be added into LastEvaluatedKey.
  - clearLastEvaluatedKeyEntries
```
public QueryResult clearLastEvaluatedKeyEntries()
```
    Removes all the entries added into LastEvaluatedKey.
    Returns a reference to this object so that method calls can be chained together.
  - getConsumedCapacity
```
public ConsumedCapacity getConsumedCapacity()
```
    Represents the capacity units consumed by an 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 it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
    
    Returns:
    Represents the capacity units consumed by an 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 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)
```
    Represents the capacity units consumed by an 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 it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    consumedCapacity - Represents the capacity units consumed by an 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 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)
```
    Represents the capacity units consumed by an 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 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 - Represents the capacity units consumed by an 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 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

Did this page help you?

Class QueryResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

QueryResult

Method Detail

getItems

setItems

withItems

withItems

getCount

setCount

withCount

getLastEvaluatedKey

setLastEvaluatedKey

withLastEvaluatedKey

addLastEvaluatedKeyEntry

clearLastEvaluatedKeyEntries

getConsumedCapacity

setConsumedCapacity

withConsumedCapacity

toString

hashCode

equals