com.amazonaws.services.dynamodbv2.model.BatchGetItemResult 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 BatchGetItem operation.
*
*/
public class BatchGetItemResult implements Serializable {
/**
* A map of table name to a list of items. Each object in
* Responses consists of a table name, along with a map of
* attribute data consisting of the data type and attribute value.
*/
private java.util.Map>> responses;
/**
* A map of tables and their respective keys that were not processed with
* the current response. The UnprocessedKeys value is in the same
* form as RequestItems, so the value can be provided directly to
* a subsequent BatchGetItem operation. For more information, see
* RequestItems in the Request Parameters section. Each element
* consists of:
-
Keys - An array of primary key
* attribute values that define specific items in the table.
-
*
AttributesToGet - One or more attributes to be retrieved
* from the table or index. By default, all attributes are returned. If a
* specified attribute is not found, it does not appear in the result.
*
-
ConsistentRead - The consistency of a read
* operation. If set to true, then a strongly consistent
* read is used; otherwise, an eventually consistent read is used.
*
If there are no unprocessed keys remaining, the response
* contains an empty UnprocessedKeys map.
*
* Constraints:
* Length: 1 - 100
*/
private java.util.Map unprocessedKeys;
/**
* The write capacity units consumed by the operation. Each element
* consists of:
-
TableName - The table that consumed
* the provisioned throughput.
-
CapacityUnits - The
* total number of capacity units consumed.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag consumedCapacity;
/**
* A map of table name to a list of items. Each object in
* Responses consists of a table name, along with a map of
* attribute data consisting of the data type and attribute value.
*
* @return A map of table name to a list of items. Each object in
* Responses consists of a table name, along with a map of
* attribute data consisting of the data type and attribute value.
*/
public java.util.Map>> getResponses() {
return responses;
}
/**
* A map of table name to a list of items. Each object in
* Responses consists of a table name, along with a map of
* attribute data consisting of the data type and attribute value.
*
* @param responses A map of table name to a list of items. Each object in
* Responses consists of a table name, along with a map of
* attribute data consisting of the data type and attribute value.
*/
public void setResponses(java.util.Map>> responses) {
this.responses = responses;
}
/**
* A map of table name to a list of items. Each object in
* Responses consists of a table name, along with a map of
* attribute data consisting of the data type and attribute value.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param responses A map of table name to a list of items. Each object in
* Responses consists of a table name, along with a map of
* attribute data consisting of the data type and attribute value.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public BatchGetItemResult withResponses(java.util.Map>> responses) {
setResponses(responses);
return this;
}
/**
* A map of table name to a list of items. Each object in
* Responses consists of a table name, along with a map of
* attribute data consisting of the data type and attribute value.
*
* The method adds a new key-value pair into Responses 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 Responses.
* @param value The corresponding value of the entry to be added into Responses.
*/
public BatchGetItemResult addResponsesEntry(String key, java.util.List> value) {
if (null == this.responses) {
this.responses = new java.util.HashMap>>();
}
if (this.responses.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.responses.put(key, value);
return this;
}
/**
* Removes all the entries added into Responses.
*
* Returns a reference to this object so that method calls can be chained together.
*/
public BatchGetItemResult clearResponsesEntries() {
this.responses = null;
return this;
}
/**
* A map of tables and their respective keys that were not processed with
* the current response. The UnprocessedKeys value is in the same
* form as RequestItems, so the value can be provided directly to
* a subsequent BatchGetItem operation. For more information, see
* RequestItems in the Request Parameters section.
Each element
* consists of:
-
Keys - An array of primary key
* attribute values that define specific items in the table.
-
*
AttributesToGet - One or more attributes to be retrieved
* from the table or index. By default, all attributes are returned. If a
* specified attribute is not found, it does not appear in the result.
*
-
ConsistentRead - The consistency of a read
* operation. If set to true, then a strongly consistent
* read is used; otherwise, an eventually consistent read is used.
*
If there are no unprocessed keys remaining, the response
* contains an empty UnprocessedKeys map.
*
* Constraints:
* Length: 1 - 100
*
* @return A map of tables and their respective keys that were not processed with
* the current response. The UnprocessedKeys value is in the same
* form as RequestItems, so the value can be provided directly to
* a subsequent BatchGetItem operation. For more information, see
* RequestItems in the Request Parameters section.
Each element
* consists of:
-
Keys - An array of primary key
* attribute values that define specific items in the table.
-
*
AttributesToGet - One or more attributes to be retrieved
* from the table or index. By default, all attributes are returned. If a
* specified attribute is not found, it does not appear in the result.
*
-
ConsistentRead - The consistency of a read
* operation. If set to true, then a strongly consistent
* read is used; otherwise, an eventually consistent read is used.
*
If there are no unprocessed keys remaining, the response
* contains an empty UnprocessedKeys map.
*/
public java.util.Map getUnprocessedKeys() {
return unprocessedKeys;
}
/**
* A map of tables and their respective keys that were not processed with
* the current response. The UnprocessedKeys value is in the same
* form as RequestItems, so the value can be provided directly to
* a subsequent BatchGetItem operation. For more information, see
* RequestItems in the Request Parameters section. Each element
* consists of:
-
Keys - An array of primary key
* attribute values that define specific items in the table.
-
*
AttributesToGet - One or more attributes to be retrieved
* from the table or index. By default, all attributes are returned. If a
* specified attribute is not found, it does not appear in the result.
*
-
ConsistentRead - The consistency of a read
* operation. If set to true, then a strongly consistent
* read is used; otherwise, an eventually consistent read is used.
*
If there are no unprocessed keys remaining, the response
* contains an empty UnprocessedKeys map.
*
* Constraints:
* Length: 1 - 100
*
* @param unprocessedKeys A map of tables and their respective keys that were not processed with
* the current response. The UnprocessedKeys value is in the same
* form as RequestItems, so the value can be provided directly to
* a subsequent BatchGetItem operation. For more information, see
* RequestItems in the Request Parameters section.
Each element
* consists of:
-
Keys - An array of primary key
* attribute values that define specific items in the table.
-
*
AttributesToGet - One or more attributes to be retrieved
* from the table or index. By default, all attributes are returned. If a
* specified attribute is not found, it does not appear in the result.
*
-
ConsistentRead - The consistency of a read
* operation. If set to true, then a strongly consistent
* read is used; otherwise, an eventually consistent read is used.
*
If there are no unprocessed keys remaining, the response
* contains an empty UnprocessedKeys map.
*/
public void setUnprocessedKeys(java.util.Map unprocessedKeys) {
this.unprocessedKeys = unprocessedKeys;
}
/**
* A map of tables and their respective keys that were not processed with
* the current response. The UnprocessedKeys value is in the same
* form as RequestItems, so the value can be provided directly to
* a subsequent BatchGetItem operation. For more information, see
* RequestItems in the Request Parameters section. Each element
* consists of:
-
Keys - An array of primary key
* attribute values that define specific items in the table.
-
*
AttributesToGet - One or more attributes to be retrieved
* from the table or index. By default, all attributes are returned. If a
* specified attribute is not found, it does not appear in the result.
*
-
ConsistentRead - The consistency of a read
* operation. If set to true, then a strongly consistent
* read is used; otherwise, an eventually consistent read is used.
*
If there are no unprocessed keys remaining, the response
* contains an empty UnprocessedKeys map.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 100
*
* @param unprocessedKeys A map of tables and their respective keys that were not processed with
* the current response. The UnprocessedKeys value is in the same
* form as RequestItems, so the value can be provided directly to
* a subsequent BatchGetItem operation. For more information, see
* RequestItems in the Request Parameters section.
Each element
* consists of:
-
Keys - An array of primary key
* attribute values that define specific items in the table.
-
*
AttributesToGet - One or more attributes to be retrieved
* from the table or index. By default, all attributes are returned. If a
* specified attribute is not found, it does not appear in the result.
*
-
ConsistentRead - The consistency of a read
* operation. If set to true, then a strongly consistent
* read is used; otherwise, an eventually consistent read is used.
*
If there are no unprocessed keys remaining, the response
* contains an empty UnprocessedKeys map.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public BatchGetItemResult withUnprocessedKeys(java.util.Map unprocessedKeys) {
setUnprocessedKeys(unprocessedKeys);
return this;
}
/**
* A map of tables and their respective keys that were not processed with
* the current response. The UnprocessedKeys value is in the same
* form as RequestItems, so the value can be provided directly to
* a subsequent BatchGetItem operation. For more information, see
* RequestItems in the Request Parameters section. Each element
* consists of:
-
Keys - An array of primary key
* attribute values that define specific items in the table.
-
*
AttributesToGet - One or more attributes to be retrieved
* from the table or index. By default, all attributes are returned. If a
* specified attribute is not found, it does not appear in the result.
*
-
ConsistentRead - The consistency of a read
* operation. If set to true, then a strongly consistent
* read is used; otherwise, an eventually consistent read is used.
*
If there are no unprocessed keys remaining, the response
* contains an empty UnprocessedKeys map.
*
* The method adds a new key-value pair into UnprocessedKeys parameter,
* and returns a reference to this object so that method calls can be
* chained together.
*
* Constraints:
* Length: 1 - 100
*
* @param key The key of the entry to be added into UnprocessedKeys.
* @param value The corresponding value of the entry to be added into UnprocessedKeys.
*/
public BatchGetItemResult addUnprocessedKeysEntry(String key, KeysAndAttributes value) {
if (null == this.unprocessedKeys) {
this.unprocessedKeys = new java.util.HashMap();
}
if (this.unprocessedKeys.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.unprocessedKeys.put(key, value);
return this;
}
/**
* Removes all the entries added into UnprocessedKeys.
*
* Returns a reference to this object so that method calls can be chained together.
*/
public BatchGetItemResult clearUnprocessedKeysEntries() {
this.unprocessedKeys = null;
return this;
}
/**
* The write capacity units consumed by the operation.
Each element
* consists of:
-
TableName - The table that consumed
* the provisioned throughput.
-
CapacityUnits - The
* total number of capacity units consumed.
*
* @return The write capacity units consumed by the operation. Each element
* consists of:
-
TableName - The table that consumed
* the provisioned throughput.
-
CapacityUnits - The
* total number of capacity units consumed.
*/
public java.util.List getConsumedCapacity() {
return consumedCapacity;
}
/**
* The write capacity units consumed by the operation. Each element
* consists of:
-
TableName - The table that consumed
* the provisioned throughput.
-
CapacityUnits - The
* total number of capacity units consumed.
*
* @param consumedCapacity The write capacity units consumed by the operation. Each element
* consists of:
-
TableName - The table that consumed
* the provisioned throughput.
-
CapacityUnits - The
* total number of capacity units consumed.
*/
public void setConsumedCapacity(java.util.Collection consumedCapacity) {
if (consumedCapacity == null) {
this.consumedCapacity = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag consumedCapacityCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(consumedCapacity.size());
consumedCapacityCopy.addAll(consumedCapacity);
this.consumedCapacity = consumedCapacityCopy;
}
/**
* The write capacity units consumed by the operation. Each element
* consists of:
-
TableName - The table that consumed
* the provisioned throughput.
-
CapacityUnits - The
* total number of capacity units consumed.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param consumedCapacity The write capacity units consumed by the operation.
Each element
* consists of:
-
TableName - The table that consumed
* the provisioned throughput.
-
CapacityUnits - The
* total number of capacity units consumed.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public BatchGetItemResult withConsumedCapacity(ConsumedCapacity... consumedCapacity) {
if (getConsumedCapacity() == null) setConsumedCapacity(new java.util.ArrayList(consumedCapacity.length));
for (ConsumedCapacity value : consumedCapacity) {
getConsumedCapacity().add(value);
}
return this;
}
/**
* The write capacity units consumed by the operation. Each element
* consists of:
-
TableName - The table that consumed
* the provisioned throughput.
-
CapacityUnits - The
* total number of capacity units consumed.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param consumedCapacity The write capacity units consumed by the operation.
Each element
* consists of:
-
TableName - The table that consumed
* the provisioned throughput.
-
CapacityUnits - The
* total number of capacity units consumed.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public BatchGetItemResult withConsumedCapacity(java.util.Collection consumedCapacity) {
if (consumedCapacity == null) {
this.consumedCapacity = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag consumedCapacityCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(consumedCapacity.size());
consumedCapacityCopy.addAll(consumedCapacity);
this.consumedCapacity = consumedCapacityCopy;
}
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 (getResponses() != null) sb.append("Responses: " + getResponses() + ",");
if (getUnprocessedKeys() != null) sb.append("UnprocessedKeys: " + getUnprocessedKeys() + ",");
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 + ((getResponses() == null) ? 0 : getResponses().hashCode());
hashCode = prime * hashCode + ((getUnprocessedKeys() == null) ? 0 : getUnprocessedKeys().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 BatchGetItemResult == false) return false;
BatchGetItemResult other = (BatchGetItemResult)obj;
if (other.getResponses() == null ^ this.getResponses() == null) return false;
if (other.getResponses() != null && other.getResponses().equals(this.getResponses()) == false) return false;
if (other.getUnprocessedKeys() == null ^ this.getUnprocessedKeys() == null) return false;
if (other.getUnprocessedKeys() != null && other.getUnprocessedKeys().equals(this.getUnprocessedKeys()) == 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;
}
}