public static interface ScanResponse.Builder extends DynamoDbResponse.Builder, CopyableBuilder<ScanResponse.Builder,ScanResponse>
| Modifier and Type | Method and Description |
|---|---|
ScanResponse.Builder |
consumedCapacity(ConsumedCapacity consumedCapacity)
The capacity units consumed by the
Scan operation. |
default ScanResponse.Builder |
consumedCapacity(Consumer<ConsumedCapacity.Builder> consumedCapacity)
The capacity units consumed by the
Scan operation. |
ScanResponse.Builder |
count(Integer count)
The number of items in the response.
|
ScanResponse.Builder |
items(Collection<Map<String,AttributeValue>> items)
An array of item attributes that match the scan criteria.
|
ScanResponse.Builder |
items(Map<String,AttributeValue>... items)
An array of item attributes that match the scan criteria.
|
ScanResponse.Builder |
lastEvaluatedKey(Map<String,AttributeValue> lastEvaluatedKey)
The primary key of the item where the operation stopped, inclusive of the previous result set.
|
ScanResponse.Builder |
scannedCount(Integer scannedCount)
The number of items evaluated, before any
ScanFilter is applied. |
buildsdkHttpResponse, sdkHttpResponsecopyapplyMutation, buildScanResponse.Builder items(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.ScanResponse.Builder items(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.ScanResponse.Builder count(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.
ScanResponse.Builder scannedCount(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.
ScanResponse.Builder lastEvaluatedKey(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.
ScanResponse.Builder consumedCapacity(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 Provisioned Throughput 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 Provisioned Throughput in the Amazon DynamoDB Developer Guide.default ScanResponse.Builder consumedCapacity(Consumer<ConsumedCapacity.Builder> 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 Provisioned Throughput in the Amazon DynamoDB Developer Guide.
ConsumedCapacity.Builder avoiding the need to
create one manually via ConsumedCapacity.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to consumedCapacity(ConsumedCapacity).consumedCapacity - a consumer that will call methods on ConsumedCapacity.BuilderconsumedCapacity(ConsumedCapacity)Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.