Interface ScanResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<ScanResponse.Builder,ScanResponse>
,DynamoDbResponse.Builder
,SdkBuilder<ScanResponse.Builder,ScanResponse>
,SdkPojo
,SdkResponse.Builder
- Enclosing class:
- ScanResponse
public static interface ScanResponse.Builder extends DynamoDbResponse.Builder, SdkPojo, CopyableBuilder<ScanResponse.Builder,ScanResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default ScanResponse.Builder
consumedCapacity(Consumer<ConsumedCapacity.Builder> consumedCapacity)
The capacity units consumed by theScan
operation.ScanResponse.Builder
consumedCapacity(ConsumedCapacity consumedCapacity)
The capacity units consumed by theScan
operation.ScanResponse.Builder
count(Integer count)
The number of items in the response.ScanResponse.Builder
items(Collection<? extends 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 anyScanFilter
is applied.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.dynamodb.model.DynamoDbResponse.Builder
build, responseMetadata, responseMetadata
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
-
-
-
Method Detail
-
items
ScanResponse.Builder items(Collection<? extends 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.
-
items
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.
- 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.
-
count
ScanResponse.Builder count(Integer count)
The number of items in the response.
If you set
ScanFilter
in the request, thenCount
is the number of items returned after the filter was applied, andScannedCount
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 asScannedCount
.- Parameters:
count
- The number of items in the response.If you set
ScanFilter
in the request, thenCount
is the number of items returned after the filter was applied, andScannedCount
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 asScannedCount
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scannedCount
ScanResponse.Builder scannedCount(Integer scannedCount)
The number of items evaluated, before any
ScanFilter
is applied. A highScannedCount
value with few, or no,Count
results indicates an inefficientScan
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 asCount
.- Parameters:
scannedCount
- The number of items evaluated, before anyScanFilter
is applied. A highScannedCount
value with few, or no,Count
results indicates an inefficientScan
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 asCount
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastEvaluatedKey
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 whenLastEvaluatedKey
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 whenLastEvaluatedKey
is empty.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
consumedCapacity
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 theReturnConsumedCapacity
parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.- Parameters:
consumedCapacity
- The capacity units consumed by theScan
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 theReturnConsumedCapacity
parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
consumedCapacity
default ScanResponse.Builder consumedCapacity(Consumer<ConsumedCapacity.Builder> consumedCapacity)
The capacity units consumed by the
This is a convenience method that creates an instance of theScan
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 theReturnConsumedCapacity
parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.ConsumedCapacity.Builder
avoiding the need to create one manually viaConsumedCapacity.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toconsumedCapacity(ConsumedCapacity)
.- Parameters:
consumedCapacity
- a consumer that will call methods onConsumedCapacity.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
consumedCapacity(ConsumedCapacity)
-
-