PutItemResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.dynamodbv2.model.PutItemResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutItemResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

Represents the output of a PutItem operation.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PutItemResult()

Constructors
Constructor and Description
`PutItemResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PutItemResult`	`addAttributesEntry(String key, AttributeValue value)`
`PutItemResult`	`clearAttributesEntries()` Removes all the entries added into Attributes.
`PutItemResult`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,AttributeValue>`	`getAttributes()` The attribute values as they appeared before the `PutItem` operation, but only if `ReturnValues` is specified as `ALL_OLD` in the request.
`ConsumedCapacity`	`getConsumedCapacity()` The capacity units consumed by the `PutItem` operation.
`ItemCollectionMetrics`	`getItemCollectionMetrics()` Information about item collections, if any, that were affected by the `PutItem` operation.
`int`	`hashCode()`
`void`	`setAttributes(Map<String,AttributeValue> attributes)` The attribute values as they appeared before the `PutItem` operation, but only if `ReturnValues` is specified as `ALL_OLD` in the request.
`void`	`setConsumedCapacity(ConsumedCapacity consumedCapacity)` The capacity units consumed by the `PutItem` operation.
`void`	`setItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics)` Information about item collections, if any, that were affected by the `PutItem` operation.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`PutItemResult`	`withAttributes(Map<String,AttributeValue> attributes)` The attribute values as they appeared before the `PutItem` operation, but only if `ReturnValues` is specified as `ALL_OLD` in the request.
`PutItemResult`	`withConsumedCapacity(ConsumedCapacity consumedCapacity)` The capacity units consumed by the `PutItem` operation.
`PutItemResult`	`withItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics)` Information about item collections, if any, that were affected by the `PutItem` operation.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PutItemResult
```
public PutItemResult()
```
- Method Detail
  - getAttributes
```
public Map<String,AttributeValue> getAttributes()
```
    The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.
    
    Returns:
    
    The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.
  - setAttributes
```
public void setAttributes(Map<String,AttributeValue> attributes)
```
    The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.
    
    Parameters:
    
    attributes - The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.
  - withAttributes
```
public PutItemResult withAttributes(Map<String,AttributeValue> attributes)
```
    The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.
    
    Parameters:
    
    attributes - The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAttributesEntry
```
public PutItemResult addAttributesEntry(String key,
                                        AttributeValue value)
```
  - clearAttributesEntries
```
public PutItemResult clearAttributesEntries()
```
    Removes all the entries added into Attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConsumedCapacity
```
public void setConsumedCapacity(ConsumedCapacity consumedCapacity)
```
    The capacity units consumed by the PutItem 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 ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    consumedCapacity - The capacity units consumed by the PutItem 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 ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
  - getConsumedCapacity
```
public ConsumedCapacity getConsumedCapacity()
```
    The capacity units consumed by the PutItem 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 ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    The capacity units consumed by the PutItem 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 ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
  - withConsumedCapacity
```
public PutItemResult withConsumedCapacity(ConsumedCapacity consumedCapacity)
```
    The capacity units consumed by the PutItem 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 ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    consumedCapacity - The capacity units consumed by the PutItem 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 ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setItemCollectionMetrics
```
public void setItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics)
```
    Information about item collections, if any, that were affected by the PutItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.
    
    Each ItemCollectionMetrics element consists of:
    - ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.
    - SizeEstimateRange - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
      
      The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
    Parameters:
    itemCollectionMetrics - Information about item collections, if any, that were affected by the PutItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.
    
    Each ItemCollectionMetrics element consists of:
    
    ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.
    
    SizeEstimateRange - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
    
    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
  - getItemCollectionMetrics
```
public ItemCollectionMetrics getItemCollectionMetrics()
```
    Information about item collections, if any, that were affected by the PutItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.
    
    Each ItemCollectionMetrics element consists of:
    - ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.
    - SizeEstimateRange - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
      
      The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
    Returns:
    Information about item collections, if any, that were affected by the PutItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.
    
    Each ItemCollectionMetrics element consists of:
    
    ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.
    
    SizeEstimateRange - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
    
    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
  - withItemCollectionMetrics
```
public PutItemResult withItemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics)
```
    Information about item collections, if any, that were affected by the PutItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.
    
    Each ItemCollectionMetrics element consists of:
    - ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.
    - SizeEstimateRange - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
      
      The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
    Parameters:
    itemCollectionMetrics - Information about item collections, if any, that were affected by the PutItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.
    
    Each ItemCollectionMetrics element consists of:
    
    ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.
    
    SizeEstimateRange - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
    
    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PutItemResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class PutItemResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

PutItemResult

Method Detail

getAttributes

setAttributes

withAttributes

addAttributesEntry

clearAttributesEntries

setConsumedCapacity

getConsumedCapacity

withConsumedCapacity

setItemCollectionMetrics

getItemCollectionMetrics

withItemCollectionMetrics

toString

equals

hashCode

clone