@Generated(value="software.amazon.awssdk:codegen") public final class QueryResponse extends DynamoDbResponse implements ToCopyableBuilder<QueryResponse.Builder,QueryResponse>
Represents the output of a Query operation.
| Modifier and Type | Class and Description |
|---|---|
static interface |
QueryResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
static QueryResponse.Builder |
builder() |
ConsumedCapacity |
consumedCapacity()
The capacity units consumed by the
Query operation. |
Integer |
count()
The number of items in the response.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasItems()
For responses, this returns true if the service returned a value for the Items property.
|
boolean |
hasLastEvaluatedKey()
For responses, this returns true if the service returned a value for the LastEvaluatedKey property.
|
List<Map<String,AttributeValue>> |
items()
An array of item attributes that match the query 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
QueryFilter is applied. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends QueryResponse.Builder> |
serializableBuilderClass() |
QueryResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final boolean hasItems()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<Map<String,AttributeValue>> items()
An array of item attributes that match the query 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasItems() method.
public final Integer count()
The number of items in the response.
If you used a QueryFilter 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 and ScannedCount are the same.
If you used a QueryFilter 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 and ScannedCount are the
same.
public final Integer scannedCount()
The number of items evaluated, before any QueryFilter is applied. A high ScannedCount
value with few, or no, Count results indicates an inefficient Query 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.
QueryFilter is applied. A high
ScannedCount value with few, or no, Count results indicates an inefficient
Query 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 final boolean hasLastEvaluatedKey()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasLastEvaluatedKey() method.
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 final ConsumedCapacity consumedCapacity()
The capacity units consumed by the Query 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.
Query 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 QueryResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<QueryResponse.Builder,QueryResponse>toBuilder in class AwsResponsepublic static QueryResponse.Builder builder()
public static Class<? extends QueryResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2022. All rights reserved.