Struct aws_sdk_dynamodb::output::delete_item_output::Builder

pub struct Builder { /* private fields */ }

A builder for DeleteItemOutput.

Implementations

impl Builder

pub fn attributes(self, k: impl Into<String>, v: AttributeValue) -> Self

Adds a key-value pair to attributes.

To override the contents of this collection use set_attributes.

A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.

pub fn set_attributes(
    self,
    input: Option<HashMap<String, AttributeValue>>
) -> Self

A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.

Examples found in repository

src/json_deser.rs (lines 1154-1158)

pub(crate) fn deser_operation_crate_operation_delete_item(
    value: &[u8],
    mut builder: crate::output::delete_item_output::Builder,
) -> Result<
    crate::output::delete_item_output::Builder,
    aws_smithy_json::deserialize::error::DeserializeError,
> {
    let mut tokens_owned =
        aws_smithy_json::deserialize::json_token_iter(crate::json_deser::or_empty_doc(value))
            .peekable();
    let tokens = &mut tokens_owned;
    aws_smithy_json::deserialize::token::expect_start_object(tokens.next())?;
    loop {
        match tokens.next().transpose()? {
            Some(aws_smithy_json::deserialize::Token::EndObject { .. }) => break,
            Some(aws_smithy_json::deserialize::Token::ObjectKey { key, .. }) => {
                match key.to_unescaped()?.as_ref() {
                    "Attributes" => {
                        builder = builder.set_attributes(
                            crate::json_deser::deser_map_com_amazonaws_dynamodb_attribute_map(
                                tokens,
                            )?,
                        );
                    }
                    "ConsumedCapacity" => {
                        builder = builder.set_consumed_capacity(
                            crate::json_deser::deser_structure_crate_model_consumed_capacity(
                                tokens,
                            )?,
                        );
                    }
                    "ItemCollectionMetrics" => {
                        builder = builder.set_item_collection_metrics(
                            crate::json_deser::deser_structure_crate_model_item_collection_metrics(
                                tokens,
                            )?,
                        );
                    }
                    _ => aws_smithy_json::deserialize::token::skip_value(tokens)?,
                }
            }
            other => {
                return Err(
                    aws_smithy_json::deserialize::error::DeserializeError::custom(format!(
                        "expected object key or end object, found: {:?}",
                        other
                    )),
                )
            }
        }
    }
    if tokens.next().is_some() {
        return Err(
            aws_smithy_json::deserialize::error::DeserializeError::custom(
                "found more JSON tokens after completing parsing",
            ),
        );
    }
    Ok(builder)
}

pub fn consumed_capacity(self, input: ConsumedCapacity) -> Self

The capacity units consumed by the DeleteItem 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 Mode in the Amazon DynamoDB Developer Guide.

pub fn set_consumed_capacity(self, input: Option<ConsumedCapacity>) -> Self

The capacity units consumed by the DeleteItem 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 Mode in the Amazon DynamoDB Developer Guide.

Examples found in repository

src/json_deser.rs (lines 1161-1165)

pub(crate) fn deser_operation_crate_operation_delete_item(
    value: &[u8],
    mut builder: crate::output::delete_item_output::Builder,
) -> Result<
    crate::output::delete_item_output::Builder,
    aws_smithy_json::deserialize::error::DeserializeError,
> {
    let mut tokens_owned =
        aws_smithy_json::deserialize::json_token_iter(crate::json_deser::or_empty_doc(value))
            .peekable();
    let tokens = &mut tokens_owned;
    aws_smithy_json::deserialize::token::expect_start_object(tokens.next())?;
    loop {
        match tokens.next().transpose()? {
            Some(aws_smithy_json::deserialize::Token::EndObject { .. }) => break,
            Some(aws_smithy_json::deserialize::Token::ObjectKey { key, .. }) => {
                match key.to_unescaped()?.as_ref() {
                    "Attributes" => {
                        builder = builder.set_attributes(
                            crate::json_deser::deser_map_com_amazonaws_dynamodb_attribute_map(
                                tokens,
                            )?,
                        );
                    }
                    "ConsumedCapacity" => {
                        builder = builder.set_consumed_capacity(
                            crate::json_deser::deser_structure_crate_model_consumed_capacity(
                                tokens,
                            )?,
                        );
                    }
                    "ItemCollectionMetrics" => {
                        builder = builder.set_item_collection_metrics(
                            crate::json_deser::deser_structure_crate_model_item_collection_metrics(
                                tokens,
                            )?,
                        );
                    }
                    _ => aws_smithy_json::deserialize::token::skip_value(tokens)?,
                }
            }
            other => {
                return Err(
                    aws_smithy_json::deserialize::error::DeserializeError::custom(format!(
                        "expected object key or end object, found: {:?}",
                        other
                    )),
                )
            }
        }
    }
    if tokens.next().is_some() {
        return Err(
            aws_smithy_json::deserialize::error::DeserializeError::custom(
                "found more JSON tokens after completing parsing",
            ),
        );
    }
    Ok(builder)
}

pub fn item_collection_metrics(self, input: ItemCollectionMetrics) -> Self

Information about item collections, if any, that were affected by the DeleteItem 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.

pub fn set_item_collection_metrics(
    self,
    input: Option<ItemCollectionMetrics>
) -> Self

Information about item collections, if any, that were affected by the DeleteItem 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.

Examples found in repository

src/json_deser.rs (lines 1168-1172)

pub(crate) fn deser_operation_crate_operation_delete_item(
    value: &[u8],
    mut builder: crate::output::delete_item_output::Builder,
) -> Result<
    crate::output::delete_item_output::Builder,
    aws_smithy_json::deserialize::error::DeserializeError,
> {
    let mut tokens_owned =
        aws_smithy_json::deserialize::json_token_iter(crate::json_deser::or_empty_doc(value))
            .peekable();
    let tokens = &mut tokens_owned;
    aws_smithy_json::deserialize::token::expect_start_object(tokens.next())?;
    loop {
        match tokens.next().transpose()? {
            Some(aws_smithy_json::deserialize::Token::EndObject { .. }) => break,
            Some(aws_smithy_json::deserialize::Token::ObjectKey { key, .. }) => {
                match key.to_unescaped()?.as_ref() {
                    "Attributes" => {
                        builder = builder.set_attributes(
                            crate::json_deser::deser_map_com_amazonaws_dynamodb_attribute_map(
                                tokens,
                            )?,
                        );
                    }
                    "ConsumedCapacity" => {
                        builder = builder.set_consumed_capacity(
                            crate::json_deser::deser_structure_crate_model_consumed_capacity(
                                tokens,
                            )?,
                        );
                    }
                    "ItemCollectionMetrics" => {
                        builder = builder.set_item_collection_metrics(
                            crate::json_deser::deser_structure_crate_model_item_collection_metrics(
                                tokens,
                            )?,
                        );
                    }
                    _ => aws_smithy_json::deserialize::token::skip_value(tokens)?,
                }
            }
            other => {
                return Err(
                    aws_smithy_json::deserialize::error::DeserializeError::custom(format!(
                        "expected object key or end object, found: {:?}",
                        other
                    )),
                )
            }
        }
    }
    if tokens.next().is_some() {
        return Err(
            aws_smithy_json::deserialize::error::DeserializeError::custom(
                "found more JSON tokens after completing parsing",
            ),
        );
    }
    Ok(builder)
}

pub fn build(self) -> DeleteItemOutput

Consumes the builder and constructs a DeleteItemOutput.

Examples found in repository

src/operation_deser.rs (line 999)

pub fn parse_delete_item_response(
    response: &http::Response<bytes::Bytes>,
) -> std::result::Result<crate::output::DeleteItemOutput, crate::error::DeleteItemError> {
    Ok({
        #[allow(unused_mut)]
        let mut output = crate::output::delete_item_output::Builder::default();
        let _ = response;
        output = crate::json_deser::deser_operation_crate_operation_delete_item(
            response.body().as_ref(),
            output,
        )
        .map_err(crate::error::DeleteItemError::unhandled)?;
        output.build()
    })
}

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Builder