com.amazonaws.services.dynamodbv2.model.ScanResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 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 Scan operation.
*
*/
public class ScanResult implements Serializable {
/**
* 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.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag> items;
/**
* The number of items in the response.
*/
private Integer count;
/**
* The number of items in the complete scan, before any filters are
* 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.
*/
private Integer scannedCount;
/**
* 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 null, then the "last page" of results has been processed and there
* is no more data to be retrieved.
If LastEvaluatedKey is
* anything other than null, this 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
* null.
*/
private java.util.Map lastEvaluatedKey;
/**
* Represents 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 it was asked
* for in the request. For more information, see Provisioned
* Throughput in the Amazon DynamoDB Developer Guide.
*/
private ConsumedCapacity consumedCapacity;
/**
* 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.
*
* @return 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.
*/
public java.util.List> getItems() {
return 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.
*
* @param 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.
*/
public void setItems(java.util.Collection> items) {
if (items == null) {
this.items = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag> itemsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag>(items.size());
itemsCopy.addAll(items);
this.items = itemsCopy;
}
/**
* 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.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ScanResult withItems(java.util.Map... items) {
if (getItems() == null) setItems(new java.util.ArrayList>(items.length));
for (java.util.Map value : items) {
getItems().add(value);
}
return this;
}
/**
* 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.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ScanResult withItems(java.util.Collection> items) {
if (items == null) {
this.items = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag> itemsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag>(items.size());
itemsCopy.addAll(items);
this.items = itemsCopy;
}
return this;
}
/**
* The number of items in the response.
*
* @return The number of items in the response.
*/
public Integer getCount() {
return count;
}
/**
* The number of items in the response.
*
* @param count The number of items in the response.
*/
public void setCount(Integer count) {
this.count = count;
}
/**
* The number of items in the response.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param count The number of items in the response.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ScanResult withCount(Integer count) {
this.count = count;
return this;
}
/**
* The number of items in the complete scan, before any filters are
* 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.
*
* @return The number of items in the complete scan, before any filters are
* 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.
*/
public Integer getScannedCount() {
return scannedCount;
}
/**
* The number of items in the complete scan, before any filters are
* 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.
*
* @param scannedCount The number of items in the complete scan, before any filters are
* 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.
*/
public void setScannedCount(Integer scannedCount) {
this.scannedCount = scannedCount;
}
/**
* The number of items in the complete scan, before any filters are
* 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.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param scannedCount The number of items in the complete scan, before any filters are
* 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ScanResult withScannedCount(Integer scannedCount) {
this.scannedCount = scannedCount;
return this;
}
/**
* 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 null, then the "last page" of results has been processed and there
* is no more data to be retrieved.
If LastEvaluatedKey is
* anything other than null, this 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
* null.
*
* @return 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 null, then the "last page" of results has been processed and there
* is no more data to be retrieved.
If LastEvaluatedKey is
* anything other than null, this 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
* null.
*/
public java.util.Map getLastEvaluatedKey() {
return 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 null, then the "last page" of results has been processed and there
* is no more data to be retrieved.
If LastEvaluatedKey is
* anything other than null, this 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
* null.
*
* @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 null, then the "last page" of results has been processed and there
* is no more data to be retrieved.
If LastEvaluatedKey is
* anything other than null, this 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
* null.
*/
public void setLastEvaluatedKey(java.util.Map lastEvaluatedKey) {
this.lastEvaluatedKey = 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 null, then the "last page" of results has been processed and there
* is no more data to be retrieved.
If LastEvaluatedKey is
* anything other than null, this 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
* null.
*
* 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 null, then the "last page" of results has been processed and there
* is no more data to be retrieved.
If LastEvaluatedKey is
* anything other than null, this 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
* null.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ScanResult withLastEvaluatedKey(java.util.Map lastEvaluatedKey) {
setLastEvaluatedKey(lastEvaluatedKey);
return this;
}
/**
* 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 null, then the "last page" of results has been processed and there
* is no more data to be retrieved.
If LastEvaluatedKey is
* anything other than null, this 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
* null.
*
* 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.
*/
public ScanResult addLastEvaluatedKeyEntry(String key, AttributeValue value) {
if (null == this.lastEvaluatedKey) {
this.lastEvaluatedKey = new java.util.HashMap();
}
if (this.lastEvaluatedKey.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.lastEvaluatedKey.put(key, value);
return this;
}
/**
* Removes all the entries added into LastEvaluatedKey.
*
* Returns a reference to this object so that method calls can be chained together.
*/
public ScanResult clearLastEvaluatedKeyEntries() {
this.lastEvaluatedKey = null;
return this;
}
/**
* Represents 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 it was asked
* for in the request. For more information, see Provisioned
* Throughput in the Amazon DynamoDB Developer Guide.
*
* @return Represents 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 it was asked
* for in the request. For more information, see Provisioned
* Throughput in the Amazon DynamoDB Developer Guide.
*/
public ConsumedCapacity getConsumedCapacity() {
return consumedCapacity;
}
/**
* Represents 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 it was asked
* for in the request. For more information, see Provisioned
* Throughput in the Amazon DynamoDB Developer Guide.
*
* @param consumedCapacity Represents 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 it was asked
* for in the request. For more information, see Provisioned
* Throughput in the Amazon DynamoDB Developer Guide.
*/
public void setConsumedCapacity(ConsumedCapacity consumedCapacity) {
this.consumedCapacity = consumedCapacity;
}
/**
* Represents 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 it was asked
* for in the request. For more information, see Provisioned
* Throughput in the Amazon DynamoDB Developer Guide.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param consumedCapacity Represents 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 it was asked
* for in the request. For more information, see Provisioned
* Throughput in the Amazon DynamoDB Developer Guide.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ScanResult withConsumedCapacity(ConsumedCapacity consumedCapacity) {
this.consumedCapacity = consumedCapacity;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getItems() != null) sb.append("Items: " + getItems() + ",");
if (getCount() != null) sb.append("Count: " + getCount() + ",");
if (getScannedCount() != null) sb.append("ScannedCount: " + getScannedCount() + ",");
if (getLastEvaluatedKey() != null) sb.append("LastEvaluatedKey: " + getLastEvaluatedKey() + ",");
if (getConsumedCapacity() != null) sb.append("ConsumedCapacity: " + getConsumedCapacity() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getItems() == null) ? 0 : getItems().hashCode());
hashCode = prime * hashCode + ((getCount() == null) ? 0 : getCount().hashCode());
hashCode = prime * hashCode + ((getScannedCount() == null) ? 0 : getScannedCount().hashCode());
hashCode = prime * hashCode + ((getLastEvaluatedKey() == null) ? 0 : getLastEvaluatedKey().hashCode());
hashCode = prime * hashCode + ((getConsumedCapacity() == null) ? 0 : getConsumedCapacity().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof ScanResult == false) return false;
ScanResult other = (ScanResult)obj;
if (other.getItems() == null ^ this.getItems() == null) return false;
if (other.getItems() != null && other.getItems().equals(this.getItems()) == false) return false;
if (other.getCount() == null ^ this.getCount() == null) return false;
if (other.getCount() != null && other.getCount().equals(this.getCount()) == false) return false;
if (other.getScannedCount() == null ^ this.getScannedCount() == null) return false;
if (other.getScannedCount() != null && other.getScannedCount().equals(this.getScannedCount()) == false) return false;
if (other.getLastEvaluatedKey() == null ^ this.getLastEvaluatedKey() == null) return false;
if (other.getLastEvaluatedKey() != null && other.getLastEvaluatedKey().equals(this.getLastEvaluatedKey()) == false) return false;
if (other.getConsumedCapacity() == null ^ this.getConsumedCapacity() == null) return false;
if (other.getConsumedCapacity() != null && other.getConsumedCapacity().equals(this.getConsumedCapacity()) == false) return false;
return true;
}
}