aws_sdk_dynamodb/operation/transact_get_items/
_transact_get_items_input.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct TransactGetItemsInput {
6    /// <p>An ordered array of up to 100 <code>TransactGetItem</code> objects, each of which contains a <code>Get</code> structure.</p>
7    pub transact_items: ::std::option::Option<::std::vec::Vec<crate::types::TransactGetItem>>,
8    /// <p>A value of <code>TOTAL</code> causes consumed capacity information to be returned, and a value of <code>NONE</code> prevents that information from being returned. No other value is valid.</p>
9    pub return_consumed_capacity: ::std::option::Option<crate::types::ReturnConsumedCapacity>,
10}
11impl TransactGetItemsInput {
12    /// <p>An ordered array of up to 100 <code>TransactGetItem</code> objects, each of which contains a <code>Get</code> structure.</p>
13    ///
14    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.transact_items.is_none()`.
15    pub fn transact_items(&self) -> &[crate::types::TransactGetItem] {
16        self.transact_items.as_deref().unwrap_or_default()
17    }
18    /// <p>A value of <code>TOTAL</code> causes consumed capacity information to be returned, and a value of <code>NONE</code> prevents that information from being returned. No other value is valid.</p>
19    pub fn return_consumed_capacity(&self) -> ::std::option::Option<&crate::types::ReturnConsumedCapacity> {
20        self.return_consumed_capacity.as_ref()
21    }
22}
23impl TransactGetItemsInput {
24    /// Creates a new builder-style object to manufacture [`TransactGetItemsInput`](crate::operation::transact_get_items::TransactGetItemsInput).
25    pub fn builder() -> crate::operation::transact_get_items::builders::TransactGetItemsInputBuilder {
26        crate::operation::transact_get_items::builders::TransactGetItemsInputBuilder::default()
27    }
28}
29
30/// A builder for [`TransactGetItemsInput`](crate::operation::transact_get_items::TransactGetItemsInput).
31#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
32#[non_exhaustive]
33pub struct TransactGetItemsInputBuilder {
34    pub(crate) transact_items: ::std::option::Option<::std::vec::Vec<crate::types::TransactGetItem>>,
35    pub(crate) return_consumed_capacity: ::std::option::Option<crate::types::ReturnConsumedCapacity>,
36}
37impl TransactGetItemsInputBuilder {
38    /// Appends an item to `transact_items`.
39    ///
40    /// To override the contents of this collection use [`set_transact_items`](Self::set_transact_items).
41    ///
42    /// <p>An ordered array of up to 100 <code>TransactGetItem</code> objects, each of which contains a <code>Get</code> structure.</p>
43    pub fn transact_items(mut self, input: crate::types::TransactGetItem) -> Self {
44        let mut v = self.transact_items.unwrap_or_default();
45        v.push(input);
46        self.transact_items = ::std::option::Option::Some(v);
47        self
48    }
49    /// <p>An ordered array of up to 100 <code>TransactGetItem</code> objects, each of which contains a <code>Get</code> structure.</p>
50    pub fn set_transact_items(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TransactGetItem>>) -> Self {
51        self.transact_items = input;
52        self
53    }
54    /// <p>An ordered array of up to 100 <code>TransactGetItem</code> objects, each of which contains a <code>Get</code> structure.</p>
55    pub fn get_transact_items(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TransactGetItem>> {
56        &self.transact_items
57    }
58    /// <p>A value of <code>TOTAL</code> causes consumed capacity information to be returned, and a value of <code>NONE</code> prevents that information from being returned. No other value is valid.</p>
59    pub fn return_consumed_capacity(mut self, input: crate::types::ReturnConsumedCapacity) -> Self {
60        self.return_consumed_capacity = ::std::option::Option::Some(input);
61        self
62    }
63    /// <p>A value of <code>TOTAL</code> causes consumed capacity information to be returned, and a value of <code>NONE</code> prevents that information from being returned. No other value is valid.</p>
64    pub fn set_return_consumed_capacity(mut self, input: ::std::option::Option<crate::types::ReturnConsumedCapacity>) -> Self {
65        self.return_consumed_capacity = input;
66        self
67    }
68    /// <p>A value of <code>TOTAL</code> causes consumed capacity information to be returned, and a value of <code>NONE</code> prevents that information from being returned. No other value is valid.</p>
69    pub fn get_return_consumed_capacity(&self) -> &::std::option::Option<crate::types::ReturnConsumedCapacity> {
70        &self.return_consumed_capacity
71    }
72    /// Consumes the builder and constructs a [`TransactGetItemsInput`](crate::operation::transact_get_items::TransactGetItemsInput).
73    pub fn build(
74        self,
75    ) -> ::std::result::Result<crate::operation::transact_get_items::TransactGetItemsInput, ::aws_smithy_types::error::operation::BuildError> {
76        ::std::result::Result::Ok(crate::operation::transact_get_items::TransactGetItemsInput {
77            transact_items: self.transact_items,
78            return_consumed_capacity: self.return_consumed_capacity,
79        })
80    }
81}