/* * Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.dynamodbv2.model; import java.io.Serializable; /** *
* Represents the output of a Query
operation.
*
* 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. *
*/ private java.util.List* 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.
*
* 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
.
*
* 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.
*
* 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.
*
* 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. *
* * @return* 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. *
*/ public java.util.List* 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. *
* * @param 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. *
*/ public void setItems(java.util.Collection* 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 a reference to this object so that method calls can be chained * together. * * @param 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. *
* @return A reference to this updated object so that method calls can be * chained together. */ public QueryResult withItems(java.util.Map* 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 a reference to this object so that method calls can be chained * together. * * @param 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. *
* @return A reference to this updated object so that method calls can be * chained together. */ public QueryResult withItems(java.util.Collection* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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 a reference to this object so that method calls can be chained * together. * * @param 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.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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 a reference to this object so that method calls can be chained * together. * * @param 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
.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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 a reference to this object so that method calls can be chained * together. * * @param 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.
*
* 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.
*
* The method adds a new key-value pair into LastEvaluatedKey parameter, and
* returns a reference to this object so that method calls can be chained
* together.
*
* @param key The key of the entry to be added into LastEvaluatedKey.
* @param value The corresponding value of the entry to be added into
* LastEvaluatedKey.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public QueryResult addLastEvaluatedKeyEntry(String key, AttributeValue value) {
if (null == this.lastEvaluatedKey) {
this.lastEvaluatedKey = new java.util.HashMap
* Returns a reference to this object so that method calls can be chained
* together.
*/
public QueryResult clearLastEvaluatedKeyEntries() {
this.lastEvaluatedKey = null;
return this;
}
/**
*
* The capacity units consumed by the
* The capacity units consumed by the
* The capacity units consumed by the
* The capacity units consumed by the
* The capacity units consumed by the
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param 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.
* 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.
* 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.
*