com.amazonaws.services.dynamodbv2.model.TransactGetItemsResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dynamodb Show documentation
/*
* Copyright 2015-2020 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;
import javax.annotation.Generated;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class TransactGetItemsResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* If the ReturnConsumedCapacity value was TOTAL, this is an array of
* ConsumedCapacity objects, one for each table addressed by TransactGetItem objects in
* the TransactItems parameter. These ConsumedCapacity objects report the read-capacity units
* consumed by the TransactGetItems call in that table.
*
*/
private java.util.List consumedCapacity;
/**
*
* An ordered array of up to 25 ItemResponse objects, each of which corresponds to the
* TransactGetItem object in the same position in the TransactItems array. Each
* ItemResponse object contains a Map of the name-value pairs that are the projected attributes of the
* requested item.
*
*
* If a requested item could not be retrieved, the corresponding ItemResponse object is Null, or if the
* requested item has no projected attributes, the corresponding ItemResponse object is an empty Map.
*
*/
private java.util.List responses;
/**
*
* If the ReturnConsumedCapacity value was TOTAL, this is an array of
* ConsumedCapacity objects, one for each table addressed by TransactGetItem objects in
* the TransactItems parameter. These ConsumedCapacity objects report the read-capacity units
* consumed by the TransactGetItems call in that table.
*
*
* @return If the ReturnConsumedCapacity value was TOTAL, this is an array of
* ConsumedCapacity objects, one for each table addressed by TransactGetItem
* objects in the TransactItems parameter. These ConsumedCapacity objects report the
* read-capacity units consumed by the TransactGetItems call in that table.
*/
public java.util.List getConsumedCapacity() {
return consumedCapacity;
}
/**
*
* If the ReturnConsumedCapacity value was TOTAL, this is an array of
* ConsumedCapacity objects, one for each table addressed by TransactGetItem objects in
* the TransactItems parameter. These ConsumedCapacity objects report the read-capacity units
* consumed by the TransactGetItems call in that table.
*
*
* @param consumedCapacity
* If the ReturnConsumedCapacity value was TOTAL, this is an array of
* ConsumedCapacity objects, one for each table addressed by TransactGetItem
* objects in the TransactItems parameter. These ConsumedCapacity objects report the
* read-capacity units consumed by the TransactGetItems call in that table.
*/
public void setConsumedCapacity(java.util.Collection consumedCapacity) {
if (consumedCapacity == null) {
this.consumedCapacity = null;
return;
}
this.consumedCapacity = new java.util.ArrayList(consumedCapacity);
}
/**
*
* If the ReturnConsumedCapacity value was TOTAL, this is an array of
* ConsumedCapacity objects, one for each table addressed by TransactGetItem objects in
* the TransactItems parameter. These ConsumedCapacity objects report the read-capacity units
* consumed by the TransactGetItems call in that table.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setConsumedCapacity(java.util.Collection)} or {@link #withConsumedCapacity(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param consumedCapacity
* If the ReturnConsumedCapacity value was TOTAL, this is an array of
* ConsumedCapacity objects, one for each table addressed by TransactGetItem
* objects in the TransactItems parameter. These ConsumedCapacity objects report the
* read-capacity units consumed by the TransactGetItems call in that table.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TransactGetItemsResult withConsumedCapacity(ConsumedCapacity... consumedCapacity) {
if (this.consumedCapacity == null) {
setConsumedCapacity(new java.util.ArrayList(consumedCapacity.length));
}
for (ConsumedCapacity ele : consumedCapacity) {
this.consumedCapacity.add(ele);
}
return this;
}
/**
*
* If the ReturnConsumedCapacity value was TOTAL, this is an array of
* ConsumedCapacity objects, one for each table addressed by TransactGetItem objects in
* the TransactItems parameter. These ConsumedCapacity objects report the read-capacity units
* consumed by the TransactGetItems call in that table.
*
*
* @param consumedCapacity
* If the ReturnConsumedCapacity value was TOTAL, this is an array of
* ConsumedCapacity objects, one for each table addressed by TransactGetItem
* objects in the TransactItems parameter. These ConsumedCapacity objects report the
* read-capacity units consumed by the TransactGetItems call in that table.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TransactGetItemsResult withConsumedCapacity(java.util.Collection consumedCapacity) {
setConsumedCapacity(consumedCapacity);
return this;
}
/**
*
* An ordered array of up to 25 ItemResponse objects, each of which corresponds to the
* TransactGetItem object in the same position in the TransactItems array. Each
* ItemResponse object contains a Map of the name-value pairs that are the projected attributes of the
* requested item.
*
*
* If a requested item could not be retrieved, the corresponding ItemResponse object is Null, or if the
* requested item has no projected attributes, the corresponding ItemResponse object is an empty Map.
*
*
* @return An ordered array of up to 25 ItemResponse objects, each of which corresponds to the
* TransactGetItem object in the same position in the TransactItems array. Each
* ItemResponse object contains a Map of the name-value pairs that are the projected attributes
* of the requested item.
*
* If a requested item could not be retrieved, the corresponding ItemResponse object is Null,
* or if the requested item has no projected attributes, the corresponding ItemResponse object
* is an empty Map.
*/
public java.util.List getResponses() {
return responses;
}
/**
*
* An ordered array of up to 25 ItemResponse objects, each of which corresponds to the
* TransactGetItem object in the same position in the TransactItems array. Each
* ItemResponse object contains a Map of the name-value pairs that are the projected attributes of the
* requested item.
*
*
* If a requested item could not be retrieved, the corresponding ItemResponse object is Null, or if the
* requested item has no projected attributes, the corresponding ItemResponse object is an empty Map.
*
*
* @param responses
* An ordered array of up to 25 ItemResponse objects, each of which corresponds to the
* TransactGetItem object in the same position in the TransactItems array. Each
* ItemResponse object contains a Map of the name-value pairs that are the projected attributes
* of the requested item.
*
* If a requested item could not be retrieved, the corresponding ItemResponse object is Null, or
* if the requested item has no projected attributes, the corresponding ItemResponse object is
* an empty Map.
*/
public void setResponses(java.util.Collection responses) {
if (responses == null) {
this.responses = null;
return;
}
this.responses = new java.util.ArrayList(responses);
}
/**
*
* An ordered array of up to 25 ItemResponse objects, each of which corresponds to the
* TransactGetItem object in the same position in the TransactItems array. Each
* ItemResponse object contains a Map of the name-value pairs that are the projected attributes of the
* requested item.
*
*
* If a requested item could not be retrieved, the corresponding ItemResponse object is Null, or if the
* requested item has no projected attributes, the corresponding ItemResponse object is an empty Map.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setResponses(java.util.Collection)} or {@link #withResponses(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param responses
* An ordered array of up to 25 ItemResponse objects, each of which corresponds to the
* TransactGetItem object in the same position in the TransactItems array. Each
* ItemResponse object contains a Map of the name-value pairs that are the projected attributes
* of the requested item.
*
* If a requested item could not be retrieved, the corresponding ItemResponse object is Null, or
* if the requested item has no projected attributes, the corresponding ItemResponse object is
* an empty Map.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TransactGetItemsResult withResponses(ItemResponse... responses) {
if (this.responses == null) {
setResponses(new java.util.ArrayList(responses.length));
}
for (ItemResponse ele : responses) {
this.responses.add(ele);
}
return this;
}
/**
*
* An ordered array of up to 25 ItemResponse objects, each of which corresponds to the
* TransactGetItem object in the same position in the TransactItems array. Each
* ItemResponse object contains a Map of the name-value pairs that are the projected attributes of the
* requested item.
*
*
* If a requested item could not be retrieved, the corresponding ItemResponse object is Null, or if the
* requested item has no projected attributes, the corresponding ItemResponse object is an empty Map.
*
*
* @param responses
* An ordered array of up to 25 ItemResponse objects, each of which corresponds to the
* TransactGetItem object in the same position in the TransactItems array. Each
* ItemResponse object contains a Map of the name-value pairs that are the projected attributes
* of the requested item.
*
* If a requested item could not be retrieved, the corresponding ItemResponse object is Null, or
* if the requested item has no projected attributes, the corresponding ItemResponse object is
* an empty Map.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TransactGetItemsResult withResponses(java.util.Collection responses) {
setResponses(responses);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getConsumedCapacity() != null)
sb.append("ConsumedCapacity: ").append(getConsumedCapacity()).append(",");
if (getResponses() != null)
sb.append("Responses: ").append(getResponses());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof TransactGetItemsResult == false)
return false;
TransactGetItemsResult other = (TransactGetItemsResult) obj;
if (other.getConsumedCapacity() == null ^ this.getConsumedCapacity() == null)
return false;
if (other.getConsumedCapacity() != null && other.getConsumedCapacity().equals(this.getConsumedCapacity()) == false)
return false;
if (other.getResponses() == null ^ this.getResponses() == null)
return false;
if (other.getResponses() != null && other.getResponses().equals(this.getResponses()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getConsumedCapacity() == null) ? 0 : getConsumedCapacity().hashCode());
hashCode = prime * hashCode + ((getResponses() == null) ? 0 : getResponses().hashCode());
return hashCode;
}
@Override
public TransactGetItemsResult clone() {
try {
return (TransactGetItemsResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}