@Generated(value="software.amazon.awssdk:codegen") public final class ScanResponse extends DynamoDbResponse implements ToCopyableBuilder<ScanResponse.Builder,ScanResponse>
Represents the output of a Scan operation.
| Modifier and Type | Class and Description |
|---|---|
static interface |
ScanResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
static ScanResponse.Builder |
builder() |
ConsumedCapacity |
consumedCapacity()
The capacity units consumed by the
Scan operation. |
Integer |
count()
The number of items in the response.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse. |
int |
hashCode() |
List<Map<String,AttributeValue>> |
items()
An array of item attributes that match the scan criteria.
|
Map<String,AttributeValue> |
lastEvaluatedKey()
The primary key of the item where the operation stopped, inclusive of the previous result set.
|
Integer |
scannedCount()
The number of items evaluated, before any
ScanFilter is applied. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends ScanResponse.Builder> |
serializableBuilderClass() |
ScanResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
responseMetadatasdkHttpResponsecopypublic List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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.
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 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.
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> 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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 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.
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.public ScanResponse.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<ScanResponse.Builder,ScanResponse>toBuilder in class AwsResponsepublic static ScanResponse.Builder builder()
public static Class<? extends ScanResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponseSdkResponse. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will
again be available.getValueForField in class SdkResponsefieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.