Package software.amazon.awssdk.services.dynamodb.model

Class QueryResponse

java.lang.Object

software.amazon.awssdk.AmazonWebServiceResult<ResponseMetadata>

software.amazon.awssdk.services.dynamodb.model.QueryResponse

All Implemented Interfaces:

ToCopyableBuilder<QueryResponse.Builder,QueryResponse>

@Generated("software.amazon.awssdk:codegen")
public class QueryResponse
extends AmazonWebServiceResult<ResponseMetadata>
implements ToCopyableBuilder<QueryResponse.Builder,QueryResponse>

Represents the output of a Query operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QueryResponse.Builder

Method Summary

Modifier and Type	Method	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)
int	hashCode()
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.
static Class<? extends QueryResponse.Builder>	serializableBuilderClass()
QueryResponse.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceResult

setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

items

public 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.

Returns:

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.

count

public 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.

Returns:

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.

scannedCount

public 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.

Returns:

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.

lastEvaluatedKey

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.

Returns:

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.

consumedCapacity

public 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.

Returns:

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.

toBuilder

public QueryResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<QueryResponse.Builder,QueryResponse>

Returns:

a builder for type T

builder

public static QueryResponse.Builder builder()

serializableBuilderClass

public static Class<? extends QueryResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object