Class ScanResult
- java.lang.Object
-
- com.amazonaws.services.dynamodbv2.model.ScanResult
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class ScanResult extends Object implements Serializable, Cloneable
Represents the output of a Scan operation.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ScanResult()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ScanResult
addLastEvaluatedKeyEntry(String key, AttributeValue value)
ScanResult
clearLastEvaluatedKeyEntries()
Removes all the entries added into LastEvaluatedKey.ScanResult
clone()
boolean
equals(Object obj)
ConsumedCapacity
getConsumedCapacity()
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 evaluated, before any ScanFilter is applied.int
hashCode()
void
setConsumedCapacity(ConsumedCapacity consumedCapacity)
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 evaluated, before any ScanFilter is applied.String
toString()
Returns a string representation of this object; useful for testing and debugging.ScanResult
withConsumedCapacity(ConsumedCapacity consumedCapacity)
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 evaluated, before any ScanFilter is applied.
-
-
-
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.
NOTE: This method appends the values to the existing list (if any). Use
setItems(java.util.Collection)
orwithItems(java.util.Collection)
if you want to override the existing values.- 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:
- Returns a reference to this 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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
setCount
public void setCount(Integer count)
The number of items in the response.
If you set ScanFilter 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 is the same as ScannedCount.
- Parameters:
count
- The number of items in the response.If you set ScanFilter 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 is the same as ScannedCount.
-
getCount
public Integer getCount()
The number of items in the response.
If you set ScanFilter 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 is the same as ScannedCount.
- Returns:
- The number of items in the response.
If you set ScanFilter 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 is the same as ScannedCount.
-
withCount
public ScanResult withCount(Integer count)
The number of items in the response.
If you set ScanFilter 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 is the same as ScannedCount.
- Parameters:
count
- The number of items in the response.If you set ScanFilter 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 is the same as ScannedCount.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setScannedCount
public void setScannedCount(Integer scannedCount)
The number of items evaluated, before any ScanFilter is 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.
If you did not use a filter in the request, then ScannedCount is the same as Count.
- Parameters:
scannedCount
- The number of items evaluated, before any ScanFilter is 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.If you did not use a filter in the request, then ScannedCount is the same as Count.
-
getScannedCount
public Integer getScannedCount()
The number of items evaluated, before any ScanFilter is 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.
If you did not use a filter in the request, then ScannedCount is the same as Count.
- Returns:
- The number of items evaluated, before any ScanFilter is
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.
If you did not use a filter in the request, then ScannedCount is the same as Count.
-
withScannedCount
public ScanResult withScannedCount(Integer scannedCount)
The number of items evaluated, before any ScanFilter is 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.
If you did not use a filter in the request, then ScannedCount is the same as Count.
- Parameters:
scannedCount
- The number of items evaluated, before any ScanFilter is 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.If you did not use a filter in the request, then ScannedCount is the same as Count.
- Returns:
- Returns a reference to this 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 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.
- 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 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.
-
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 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.
- 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 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.
-
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.
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.
- 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 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addLastEvaluatedKeyEntry
public ScanResult addLastEvaluatedKeyEntry(String key, AttributeValue value)
-
clearLastEvaluatedKeyEntries
public ScanResult clearLastEvaluatedKeyEntries()
Removes all the entries added into LastEvaluatedKey. <p> Returns a reference to this object so that method calls can be chained together.
-
setConsumedCapacity
public void setConsumedCapacity(ConsumedCapacity consumedCapacity)
- Parameters:
consumedCapacity
-
-
getConsumedCapacity
public ConsumedCapacity getConsumedCapacity()
- Returns:
-
withConsumedCapacity
public ScanResult withConsumedCapacity(ConsumedCapacity consumedCapacity)
- Parameters:
consumedCapacity
-- Returns:
- Returns a reference to this 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public ScanResult clone()
-
-