com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dynamodb Show documentation
/*
* Copyright 2013-2024 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.
* You may obtain a copy of the License at:
*
* http://aws.amazon.com/apache2.0
*
* 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.datamodeling;
import java.util.List;
import java.util.Map;
import com.amazonaws.services.dynamodbv2.model.AttributeValue;
import com.amazonaws.services.dynamodbv2.model.ConsumedCapacity;
/**
* Container for a page of query results
*/
public class QueryResultPage {
private List results;
private Map lastEvaluatedKey;
private Integer count;
private Integer scannedCount;
private ConsumedCapacity consumedCapacity;
/**
* Returns all matching items for this page of query results.
*/
public List getResults() {
return results;
}
public void setResults(List results) {
this.results = results;
}
/**
* Returns the last evaluated key, which can be used as the
* exclusiveStartKey to fetch the next page of results. Returns null if this
* is the last page of results.
*
* @return The key-value pairs which map from the attribute name of each component
* of the primary key to its value.
*/
public Map getLastEvaluatedKey() {
return lastEvaluatedKey;
}
public void setLastEvaluatedKey(Map lastEvaluatedKey) {
this.lastEvaluatedKey = lastEvaluatedKey;
}
/**
* 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.
*
* @return 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.
*/
public Integer getCount() {
return count;
}
public void setCount(Integer count) {
this.count = 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.
*
* @return 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.
*/
public Integer getScannedCount() {
return scannedCount;
}
public void setScannedCount(Integer scannedCount) {
this.scannedCount = scannedCount;
}
/**
* The capacity units consumed by an 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 request asked for it.
* For more information, see Provisioned
* Throughput in the Amazon DynamoDB Developer Guide.
*
* @return The capacity units consumed by an 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 request asked for it.
* For more information, see Provisioned
* Throughput in the Amazon DynamoDB Developer Guide.
*/
public ConsumedCapacity getConsumedCapacity() {
return consumedCapacity;
}
public void setConsumedCapacity(ConsumedCapacity consumedCapacity) {
this.consumedCapacity = consumedCapacity;
}
}