software.amazon.awssdk.services.dynamodb.model

Interface PutItemResponse.Builder

All Superinterfaces:

CopyableBuilder<PutItemResponse.Builder,PutItemResponse>, DynamoDbResponse.Builder, SdkBuilder<PutItemResponse.Builder,PutItemResponse>

Enclosing class:

PutItemResponse

public static interface PutItemResponse.Builder
extends DynamoDbResponse.Builder, CopyableBuilder<PutItemResponse.Builder,PutItemResponse>

Method Summary

Modifier and Type	Method and Description
PutItemResponse.Builder	attributes(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.
PutItemResponse.Builder	consumedCapacity(ConsumedCapacity consumedCapacity) The capacity units consumed by the PutItem operation.
default PutItemResponse.Builder	consumedCapacity(Consumer<ConsumedCapacity.Builder> consumedCapacity) The capacity units consumed by the PutItem operation.
default PutItemResponse.Builder	itemCollectionMetrics(Consumer<ItemCollectionMetrics.Builder> itemCollectionMetrics) Information about item collections, if any, that were affected by the PutItem operation.
PutItemResponse.Builder	itemCollectionMetrics(ItemCollectionMetrics itemCollectionMetrics) Information about item collections, if any, that were affected by the PutItem operation.

Methods inherited from interface software.amazon.awssdk.services.dynamodb.model.DynamoDbResponse.Builder

build

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

attributes

PutItemResponse.Builder attributes(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.

consumedCapacity

PutItemResponse.Builder consumedCapacity(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.

consumedCapacity

default PutItemResponse.Builder consumedCapacity(Consumer<ConsumedCapacity.Builder> 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.

This is a convenience that creates an instance of the ConsumedCapacity.Builder avoiding the need to create one manually via ConsumedCapacity.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to consumedCapacity(ConsumedCapacity).

Parameters:

consumedCapacity - a consumer that will call methods on ConsumedCapacity.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

consumedCapacity(ConsumedCapacity)

itemCollectionMetrics

PutItemResponse.Builder itemCollectionMetrics(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.

• SizeEstimateRangeGB - 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.

• SizeEstimateRangeGB - 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.

itemCollectionMetrics

default PutItemResponse.Builder itemCollectionMetrics(Consumer<ItemCollectionMetrics.Builder> 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.

• SizeEstimateRangeGB - 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.

This is a convenience that creates an instance of the ItemCollectionMetrics.Builder avoiding the need to create one manually via ItemCollectionMetrics.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to itemCollectionMetrics(ItemCollectionMetrics).

Parameters:

itemCollectionMetrics - a consumer that will call methods on ItemCollectionMetrics.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

itemCollectionMetrics(ItemCollectionMetrics)