@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ScanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Represents the output of a Scan
operation.
Constructor and Description |
---|
ScanResult() |
Modifier and Type | Method and Description |
---|---|
ScanResult |
addLastEvaluatedKeyEntry(String key,
AttributeValue value)
Add a single LastEvaluatedKey entry
|
ScanResult |
clearLastEvaluatedKeyEntries()
Removes all the entries added into LastEvaluatedKey.
|
ScanResult |
clone() |
boolean |
equals(Object obj) |
ConsumedCapacity |
getConsumedCapacity()
The capacity units consumed by the
Scan operation. |
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)
The capacity units consumed by the
Scan 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 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.
|
ScanResult |
withConsumedCapacity(ConsumedCapacity consumedCapacity)
The capacity units consumed by the
Scan operation. |
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. |
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
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.
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.
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.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)
or withItems(java.util.Collection)
if you want to override the
existing values.
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.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.
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.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
.
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
.
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
.
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
.
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
.
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
.
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
.
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
.
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
.
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
.
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
.
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
.
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.
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.
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.
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.
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.
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.
public ScanResult addLastEvaluatedKeyEntry(String key, AttributeValue value)
public ScanResult clearLastEvaluatedKeyEntries()
public void setConsumedCapacity(ConsumedCapacity consumedCapacity)
The capacity units consumed by the Scan
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 ReturnConsumedCapacity
parameter was
specified. For more information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.
consumedCapacity
- The capacity units consumed by the Scan
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 ReturnConsumedCapacity
parameter was specified. For more information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.public ConsumedCapacity getConsumedCapacity()
The capacity units consumed by the Scan
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 ReturnConsumedCapacity
parameter was
specified. For more information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.
Scan
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 ReturnConsumedCapacity
parameter was specified. For more information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.public ScanResult withConsumedCapacity(ConsumedCapacity consumedCapacity)
The capacity units consumed by the Scan
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 ReturnConsumedCapacity
parameter was
specified. For more information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.
consumedCapacity
- The capacity units consumed by the Scan
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 ReturnConsumedCapacity
parameter was specified. For more information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.public String toString()
toString
in class Object
Object.toString()
public ScanResult clone()