@Generated(value="software.amazon.awssdk:codegen") public class UpdateItemResponse extends DynamoDBResponse implements ToCopyableBuilder<UpdateItemResponse.Builder,UpdateItemResponse>
Represents the output of an UpdateItem
operation.
Modifier and Type | Class and Description |
---|---|
static interface |
UpdateItemResponse.Builder |
Modifier and Type | Method and Description |
---|---|
Map<String,AttributeValue> |
attributes()
A map of attribute values as they appear before or after the
UpdateItem operation, as determined by
the ReturnValues parameter. |
static UpdateItemResponse.Builder |
builder() |
ConsumedCapacity |
consumedCapacity()
The capacity units consumed by the
UpdateItem operation. |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
int |
hashCode() |
ItemCollectionMetrics |
itemCollectionMetrics()
Information about item collections, if any, that were affected by the
UpdateItem operation. |
static Class<? extends UpdateItemResponse.Builder> |
serializableBuilderClass() |
UpdateItemResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public Map<String,AttributeValue> attributes()
A map of attribute values as they appear before or after the UpdateItem
operation, as determined by
the ReturnValues
parameter.
The Attributes
map is only present if ReturnValues
was specified as something other
than NONE
in the request. Each element represents one attribute.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
UpdateItem
operation, as
determined by the ReturnValues
parameter.
The Attributes
map is only present if ReturnValues
was specified as something
other than NONE
in the request. Each element represents one attribute.
public ConsumedCapacity consumedCapacity()
The capacity units consumed by the UpdateItem
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.
UpdateItem
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.public ItemCollectionMetrics itemCollectionMetrics()
Information about item collections, if any, that were affected by the UpdateItem
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.
UpdateItem
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.
public UpdateItemResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<UpdateItemResponse.Builder,UpdateItemResponse>
toBuilder
in class AwsResponse
public static UpdateItemResponse.Builder builder()
public static Class<? extends UpdateItemResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.