Class ScanResultPage<T>
- java.lang.Object
-
- com.amazonaws.services.dynamodbv2.datamodeling.ScanResultPage<T>
-
public class ScanResultPage<T> extends Object
Container for a page of scan results.
-
-
Constructor Summary
Constructors Constructor Description ScanResultPage()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ConsumedCapacity
getConsumedCapacity()
The capacity units consumed by an operation.Integer
getCount()
The number of items in the response.Map<String,AttributeValue>
getLastEvaluatedKey()
Returns the last evaluated key, which can be used as the exclusiveStartKey to fetch the next page of results.List<T>
getResults()
Returns all matching items for this page of scan results, which may be empty.Integer
getScannedCount()
The number of items evaluated, before any ScanFilter is applied.void
setConsumedCapacity(ConsumedCapacity consumedCapacity)
void
setCount(Integer count)
void
setLastEvaluatedKey(Map<String,AttributeValue> lastEvaluatedKey)
void
setResults(List<T> results)
void
setScannedCount(Integer scannedCount)
-
-
-
Method Detail
-
getResults
public List<T> getResults()
Returns all matching items for this page of scan results, which may be empty.
-
getLastEvaluatedKey
public Map<String,AttributeValue> getLastEvaluatedKey()
Returns the last evaluated key, which can be used as the exclusiveStartKey to fetch the next page of results. Returns null if this is the last page of results.- Returns:
- The key-value pairs which map from the attribute name of each component of the primary key to its value.
-
setLastEvaluatedKey
public void setLastEvaluatedKey(Map<String,AttributeValue> lastEvaluatedKey)
-
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.
-
setCount
public void setCount(Integer 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.
-
setScannedCount
public void setScannedCount(Integer scannedCount)
-
getConsumedCapacity
public ConsumedCapacity getConsumedCapacity()
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 the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.- Returns:
- 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 the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
-
setConsumedCapacity
public void setConsumedCapacity(ConsumedCapacity consumedCapacity)
-
-