ScanResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.dynamodbv2.model.ScanResult

All Implemented Interfaces:

Serializable
```
public class ScanResult
extends Object
implements Serializable
```
Represents the output of a Scan operation.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

ScanResult()

Constructors
Constructor and Description
`ScanResult()`

Method Summary

Methods
Modifier and Type	Method and Description
`ScanResult`	`addLastEvaluatedKeyEntry(String key, AttributeValue value)` The primary key of the item where the operation stopped, inclusive of the previous result set.
`ScanResult`	`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 scan 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 in the complete scan, before any filters are applied.
`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 scan 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 in the complete scan, before any filters are applied.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ScanResult`	`withConsumedCapacity(ConsumedCapacity consumedCapacity)` The table name that consumed provisioned throughput, and the number of capacity units consumed by it.
`ScanResult`	`withCount(Integer count)` The number of items in the response.
`ScanResult`	`withItems(Collection<Map<String,AttributeValue>> items)` An array of item attributes that match the scan criteria.
`ScanResult`	`withItems(Map<String,AttributeValue>... items)` An array of item attributes that match the scan criteria.
`ScanResult`	`withLastEvaluatedKey(Map<String,AttributeValue> lastEvaluatedKey)` The primary key of the item where the operation stopped, inclusive of the previous result set.
`ScanResult`	`withScannedCount(Integer scannedCount)` The number of items in the complete scan, before any filters are applied.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ScanResult
```
public ScanResult()
```
- Method Detail
  - getItems
```
public List<Map<String,AttributeValue>> getItems()
```
    An array of item attributes that match the scan 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 scan 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 scan 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 scan criteria. Each element in this array consists of an attribute name and the value for that attribute.
  - withItems
```
public ScanResult withItems(Map<String,AttributeValue>... items)
```
    An array of item attributes that match the scan 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 scan 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 ScanResult withItems(Collection<Map<String,AttributeValue>> items)
```
    An array of item attributes that match the scan 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 scan 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 ScanResult 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.
  - getScannedCount
```
public Integer getScannedCount()
```
    The number of items in the complete scan, before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
    
    Returns:
    The number of items in the complete scan, before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
  - setScannedCount
```
public void setScannedCount(Integer scannedCount)
```
    The number of items in the complete scan, before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    scannedCount - The number of items in the complete scan, before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
  - withScannedCount
```
public ScanResult withScannedCount(Integer scannedCount)
```
    The number of items in the complete scan, before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    scannedCount - The number of items in the complete scan, before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
    
    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).
    If there are no remaining table or segment items to be scanned, LastEvaluatedKey is returned as 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.
    LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).
    If there are no remaining table or segment items to be scanned, LastEvaluatedKey is returned as 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.
    LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).
    If there are no remaining table or segment items to be scanned, LastEvaluatedKey is returned as 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.
    LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).
    If there are no remaining table or segment items to be scanned, LastEvaluatedKey is returned as null.
  - withLastEvaluatedKey
```
public ScanResult 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).
    If there are no remaining table or segment items to be scanned, LastEvaluatedKey is returned as 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.
    LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).
    If there are no remaining table or segment items to be scanned, LastEvaluatedKey is returned as null.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - addLastEvaluatedKeyEntry
```
public ScanResult 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.
    LastEvaluatedKey is null when the entire result set is complete (in other words, when the operation processed the "last page" of results).
    If there are no remaining table or segment items to be scanned, LastEvaluatedKey is returned as 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 ScanResult 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()
```
    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 ScanResult 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

Did this page help you?

Class ScanResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ScanResult

Method Detail

getItems

setItems

withItems

withItems

getCount

setCount

withCount

getScannedCount

setScannedCount

withScannedCount

getLastEvaluatedKey

setLastEvaluatedKey

withLastEvaluatedKey

addLastEvaluatedKeyEntry

clearLastEvaluatedKeyEntries

getConsumedCapacity

setConsumedCapacity

withConsumedCapacity

toString

hashCode

equals