com.amazonaws.services.dynamodb.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.dynamodb.model;
import java.io.Serializable;
/**
* Scan Result
* @deprecated Use {@link com.amazonaws.services.dynamodbv2.model.ScanResult} instead.
*/
@Deprecated
public class ScanResult implements Serializable {
private java.util.List> items;
/**
* Number of items in the response.
*/
private Integer count;
/**
* 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.
*/
private Integer scannedCount;
/**
* Primary key of the item where the scan operation stopped. Provide this
* value in a subsequent scan operation to continue the operation from
* that point. The LastEvaluatedKey is null when the entire
* scan result set is complete (i.e. the operation processed the "last
* page").
*/
private Key lastEvaluatedKey;
/**
* The number of Capacity Units of the provisioned throughput of the
* table consumed during the operation. GetItem,
* BatchGetItem, BatchWriteItem,
* Query, and Scan operations consume
* ReadCapacityUnits, while PutItem,
* UpdateItem, and DeleteItem operations
* consume WriteCapacityUnits.
*/
private Double consumedCapacityUnits;
/**
* Returns the value of the Items property for this object.
*
* @return The value of the Items property for this object.
*/
public java.util.List> getItems() {
return items;
}
/**
* Sets the value of the Items property for this object.
*
* @param items The new value for the Items property for this object.
*/
public void setItems(java.util.Collection> items) {
if (items == null) {
this.items = null;
return;
}
java.util.List> itemsCopy = new java.util.ArrayList>(items.size());
itemsCopy.addAll(items);
this.items = itemsCopy;
}
/**
* Sets the value of the Items property for this object.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param items The new value for the Items property for this object.
*
* @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;
}
/**
* Sets the value of the Items property for this object.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param items The new value for the Items property for this object.
*
* @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 {
java.util.List> itemsCopy = new java.util.ArrayList>(items.size());
itemsCopy.addAll(items);
this.items = itemsCopy;
}
return this;
}
/**
* Number of items in the response.
*
* @return Number of items in the response.
*/
public Integer getCount() {
return count;
}
/**
* Number of items in the response.
*
* @param count Number of items in the response.
*/
public void setCount(Integer count) {
this.count = count;
}
/**
* Number of items in the response.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param count 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;
}
/**
* 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.
*
* @return 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.
*/
public Integer getScannedCount() {
return scannedCount;
}
/**
* 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.
*
* @param scannedCount 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.
*/
public void setScannedCount(Integer scannedCount) {
this.scannedCount = scannedCount;
}
/**
* 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.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param scannedCount 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.
*
* @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;
}
/**
* Primary key of the item where the scan operation stopped. Provide this
* value in a subsequent scan operation to continue the operation from
* that point. The LastEvaluatedKey is null when the entire
* scan result set is complete (i.e. the operation processed the "last
* page").
*
* @return Primary key of the item where the scan operation stopped. Provide this
* value in a subsequent scan operation to continue the operation from
* that point. The LastEvaluatedKey is null when the entire
* scan result set is complete (i.e. the operation processed the "last
* page").
*/
public Key getLastEvaluatedKey() {
return lastEvaluatedKey;
}
/**
* Primary key of the item where the scan operation stopped. Provide this
* value in a subsequent scan operation to continue the operation from
* that point. The LastEvaluatedKey is null when the entire
* scan result set is complete (i.e. the operation processed the "last
* page").
*
* @param lastEvaluatedKey Primary key of the item where the scan operation stopped. Provide this
* value in a subsequent scan operation to continue the operation from
* that point. The LastEvaluatedKey is null when the entire
* scan result set is complete (i.e. the operation processed the "last
* page").
*/
public void setLastEvaluatedKey(Key lastEvaluatedKey) {
this.lastEvaluatedKey = lastEvaluatedKey;
}
/**
* Primary key of the item where the scan operation stopped. Provide this
* value in a subsequent scan operation to continue the operation from
* that point. The LastEvaluatedKey is null when the entire
* scan result set is complete (i.e. the operation processed the "last
* page").
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param lastEvaluatedKey Primary key of the item where the scan operation stopped. Provide this
* value in a subsequent scan operation to continue the operation from
* that point. The LastEvaluatedKey is null when the entire
* scan result set is complete (i.e. the operation processed the "last
* page").
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ScanResult withLastEvaluatedKey(Key lastEvaluatedKey) {
this.lastEvaluatedKey = lastEvaluatedKey;
return this;
}
/**
* The number of Capacity Units of the provisioned throughput of the
* table consumed during the operation. GetItem,
* BatchGetItem, BatchWriteItem,
* Query, and Scan operations consume
* ReadCapacityUnits, while PutItem,
* UpdateItem, and DeleteItem operations
* consume WriteCapacityUnits.
*
* @return The number of Capacity Units of the provisioned throughput of the
* table consumed during the operation. GetItem,
* BatchGetItem, BatchWriteItem,
* Query, and Scan operations consume
* ReadCapacityUnits, while PutItem,
* UpdateItem, and DeleteItem operations
* consume WriteCapacityUnits.
*/
public Double getConsumedCapacityUnits() {
return consumedCapacityUnits;
}
/**
* The number of Capacity Units of the provisioned throughput of the
* table consumed during the operation. GetItem,
* BatchGetItem, BatchWriteItem,
* Query, and Scan operations consume
* ReadCapacityUnits, while PutItem,
* UpdateItem, and DeleteItem operations
* consume WriteCapacityUnits.
*
* @param consumedCapacityUnits The number of Capacity Units of the provisioned throughput of the
* table consumed during the operation. GetItem,
* BatchGetItem, BatchWriteItem,
* Query, and Scan operations consume
* ReadCapacityUnits, while PutItem,
* UpdateItem, and DeleteItem operations
* consume WriteCapacityUnits.
*/
public void setConsumedCapacityUnits(Double consumedCapacityUnits) {
this.consumedCapacityUnits = consumedCapacityUnits;
}
/**
* The number of Capacity Units of the provisioned throughput of the
* table consumed during the operation. GetItem,
* BatchGetItem, BatchWriteItem,
* Query, and Scan operations consume
* ReadCapacityUnits, while PutItem,
* UpdateItem, and DeleteItem operations
* consume WriteCapacityUnits.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param consumedCapacityUnits The number of Capacity Units of the provisioned throughput of the
* table consumed during the operation. GetItem,
* BatchGetItem, BatchWriteItem,
* Query, and Scan operations consume
* ReadCapacityUnits, while PutItem,
* UpdateItem, and DeleteItem operations
* consume WriteCapacityUnits.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ScanResult withConsumedCapacityUnits(Double consumedCapacityUnits) {
this.consumedCapacityUnits = consumedCapacityUnits;
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 (getConsumedCapacityUnits() != null) sb.append("ConsumedCapacityUnits: " + getConsumedCapacityUnits() + ", ");
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 + ((getConsumedCapacityUnits() == null) ? 0 : getConsumedCapacityUnits().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.getConsumedCapacityUnits() == null ^ this.getConsumedCapacityUnits() == null) return false;
if (other.getConsumedCapacityUnits() != null && other.getConsumedCapacityUnits().equals(this.getConsumedCapacityUnits()) == false) return false;
return true;
}
}