1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
/// <p>Represents the output of a <code>BatchGetItem</code> operation.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct BatchGetItemOutput {
/// <p>A map of table name or table ARN to a list of items. Each object in <code>Responses</code> consists of a table name or ARN, along with a map of attribute data consisting of the data type and attribute value.</p>
pub responses: ::std::option::Option<
::std::collections::HashMap<
::std::string::String,
::std::vec::Vec<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
>,
>,
/// <p>A map of tables and their respective keys that were not processed with the current response. The <code>UnprocessedKeys</code> value is in the same form as <code>RequestItems</code>, so the value can be provided directly to a subsequent <code>BatchGetItem</code> operation. For more information, see <code>RequestItems</code> in the Request Parameters section.</p>
/// <p>Each element consists of:</p>
/// <ul>
/// <li>
/// <p><code>Keys</code> - An array of primary key attribute values that define specific items in the table.</p></li>
/// <li>
/// <p><code>ProjectionExpression</code> - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.</p></li>
/// <li>
/// <p><code>ConsistentRead</code> - The consistency of a read operation. If set to <code>true</code>, then a strongly consistent read is used; otherwise, an eventually consistent read is used.</p></li>
/// </ul>
/// <p>If there are no unprocessed keys remaining, the response contains an empty <code>UnprocessedKeys</code> map.</p>
pub unprocessed_keys: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::KeysAndAttributes>>,
/// <p>The read capacity units consumed by the entire <code>BatchGetItem</code> operation.</p>
/// <p>Each element consists of:</p>
/// <ul>
/// <li>
/// <p><code>TableName</code> - The table that consumed the provisioned throughput.</p></li>
/// <li>
/// <p><code>CapacityUnits</code> - The total number of capacity units consumed.</p></li>
/// </ul>
pub consumed_capacity: ::std::option::Option<::std::vec::Vec<crate::types::ConsumedCapacity>>,
_request_id: Option<String>,
}
impl BatchGetItemOutput {
/// <p>A map of table name or table ARN to a list of items. Each object in <code>Responses</code> consists of a table name or ARN, along with a map of attribute data consisting of the data type and attribute value.</p>
pub fn responses(
&self,
) -> ::std::option::Option<
&::std::collections::HashMap<
::std::string::String,
::std::vec::Vec<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
>,
> {
self.responses.as_ref()
}
/// <p>A map of tables and their respective keys that were not processed with the current response. The <code>UnprocessedKeys</code> value is in the same form as <code>RequestItems</code>, so the value can be provided directly to a subsequent <code>BatchGetItem</code> operation. For more information, see <code>RequestItems</code> in the Request Parameters section.</p>
/// <p>Each element consists of:</p>
/// <ul>
/// <li>
/// <p><code>Keys</code> - An array of primary key attribute values that define specific items in the table.</p></li>
/// <li>
/// <p><code>ProjectionExpression</code> - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.</p></li>
/// <li>
/// <p><code>ConsistentRead</code> - The consistency of a read operation. If set to <code>true</code>, then a strongly consistent read is used; otherwise, an eventually consistent read is used.</p></li>
/// </ul>
/// <p>If there are no unprocessed keys remaining, the response contains an empty <code>UnprocessedKeys</code> map.</p>
pub fn unprocessed_keys(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, crate::types::KeysAndAttributes>> {
self.unprocessed_keys.as_ref()
}
/// <p>The read capacity units consumed by the entire <code>BatchGetItem</code> operation.</p>
/// <p>Each element consists of:</p>
/// <ul>
/// <li>
/// <p><code>TableName</code> - The table that consumed the provisioned throughput.</p></li>
/// <li>
/// <p><code>CapacityUnits</code> - The total number of capacity units consumed.</p></li>
/// </ul>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.consumed_capacity.is_none()`.
pub fn consumed_capacity(&self) -> &[crate::types::ConsumedCapacity] {
self.consumed_capacity.as_deref().unwrap_or_default()
}
}
impl ::aws_types::request_id::RequestId for BatchGetItemOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl BatchGetItemOutput {
/// Creates a new builder-style object to manufacture [`BatchGetItemOutput`](crate::operation::batch_get_item::BatchGetItemOutput).
pub fn builder() -> crate::operation::batch_get_item::builders::BatchGetItemOutputBuilder {
crate::operation::batch_get_item::builders::BatchGetItemOutputBuilder::default()
}
}
/// A builder for [`BatchGetItemOutput`](crate::operation::batch_get_item::BatchGetItemOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct BatchGetItemOutputBuilder {
pub(crate) responses: ::std::option::Option<
::std::collections::HashMap<
::std::string::String,
::std::vec::Vec<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
>,
>,
pub(crate) unprocessed_keys: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::KeysAndAttributes>>,
pub(crate) consumed_capacity: ::std::option::Option<::std::vec::Vec<crate::types::ConsumedCapacity>>,
_request_id: Option<String>,
}
impl BatchGetItemOutputBuilder {
/// Adds a key-value pair to `responses`.
///
/// To override the contents of this collection use [`set_responses`](Self::set_responses).
///
/// <p>A map of table name or table ARN to a list of items. Each object in <code>Responses</code> consists of a table name or ARN, along with a map of attribute data consisting of the data type and attribute value.</p>
pub fn responses(
mut self,
k: impl ::std::convert::Into<::std::string::String>,
v: ::std::vec::Vec<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
) -> Self {
let mut hash_map = self.responses.unwrap_or_default();
hash_map.insert(k.into(), v);
self.responses = ::std::option::Option::Some(hash_map);
self
}
/// <p>A map of table name or table ARN to a list of items. Each object in <code>Responses</code> consists of a table name or ARN, along with a map of attribute data consisting of the data type and attribute value.</p>
pub fn set_responses(
mut self,
input: ::std::option::Option<
::std::collections::HashMap<
::std::string::String,
::std::vec::Vec<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
>,
>,
) -> Self {
self.responses = input;
self
}
/// <p>A map of table name or table ARN to a list of items. Each object in <code>Responses</code> consists of a table name or ARN, along with a map of attribute data consisting of the data type and attribute value.</p>
pub fn get_responses(
&self,
) -> &::std::option::Option<
::std::collections::HashMap<
::std::string::String,
::std::vec::Vec<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
>,
> {
&self.responses
}
/// Adds a key-value pair to `unprocessed_keys`.
///
/// To override the contents of this collection use [`set_unprocessed_keys`](Self::set_unprocessed_keys).
///
/// <p>A map of tables and their respective keys that were not processed with the current response. The <code>UnprocessedKeys</code> value is in the same form as <code>RequestItems</code>, so the value can be provided directly to a subsequent <code>BatchGetItem</code> operation. For more information, see <code>RequestItems</code> in the Request Parameters section.</p>
/// <p>Each element consists of:</p>
/// <ul>
/// <li>
/// <p><code>Keys</code> - An array of primary key attribute values that define specific items in the table.</p></li>
/// <li>
/// <p><code>ProjectionExpression</code> - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.</p></li>
/// <li>
/// <p><code>ConsistentRead</code> - The consistency of a read operation. If set to <code>true</code>, then a strongly consistent read is used; otherwise, an eventually consistent read is used.</p></li>
/// </ul>
/// <p>If there are no unprocessed keys remaining, the response contains an empty <code>UnprocessedKeys</code> map.</p>
pub fn unprocessed_keys(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::KeysAndAttributes) -> Self {
let mut hash_map = self.unprocessed_keys.unwrap_or_default();
hash_map.insert(k.into(), v);
self.unprocessed_keys = ::std::option::Option::Some(hash_map);
self
}
/// <p>A map of tables and their respective keys that were not processed with the current response. The <code>UnprocessedKeys</code> value is in the same form as <code>RequestItems</code>, so the value can be provided directly to a subsequent <code>BatchGetItem</code> operation. For more information, see <code>RequestItems</code> in the Request Parameters section.</p>
/// <p>Each element consists of:</p>
/// <ul>
/// <li>
/// <p><code>Keys</code> - An array of primary key attribute values that define specific items in the table.</p></li>
/// <li>
/// <p><code>ProjectionExpression</code> - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.</p></li>
/// <li>
/// <p><code>ConsistentRead</code> - The consistency of a read operation. If set to <code>true</code>, then a strongly consistent read is used; otherwise, an eventually consistent read is used.</p></li>
/// </ul>
/// <p>If there are no unprocessed keys remaining, the response contains an empty <code>UnprocessedKeys</code> map.</p>
pub fn set_unprocessed_keys(
mut self,
input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::KeysAndAttributes>>,
) -> Self {
self.unprocessed_keys = input;
self
}
/// <p>A map of tables and their respective keys that were not processed with the current response. The <code>UnprocessedKeys</code> value is in the same form as <code>RequestItems</code>, so the value can be provided directly to a subsequent <code>BatchGetItem</code> operation. For more information, see <code>RequestItems</code> in the Request Parameters section.</p>
/// <p>Each element consists of:</p>
/// <ul>
/// <li>
/// <p><code>Keys</code> - An array of primary key attribute values that define specific items in the table.</p></li>
/// <li>
/// <p><code>ProjectionExpression</code> - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.</p></li>
/// <li>
/// <p><code>ConsistentRead</code> - The consistency of a read operation. If set to <code>true</code>, then a strongly consistent read is used; otherwise, an eventually consistent read is used.</p></li>
/// </ul>
/// <p>If there are no unprocessed keys remaining, the response contains an empty <code>UnprocessedKeys</code> map.</p>
pub fn get_unprocessed_keys(
&self,
) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::KeysAndAttributes>> {
&self.unprocessed_keys
}
/// Appends an item to `consumed_capacity`.
///
/// To override the contents of this collection use [`set_consumed_capacity`](Self::set_consumed_capacity).
///
/// <p>The read capacity units consumed by the entire <code>BatchGetItem</code> operation.</p>
/// <p>Each element consists of:</p>
/// <ul>
/// <li>
/// <p><code>TableName</code> - The table that consumed the provisioned throughput.</p></li>
/// <li>
/// <p><code>CapacityUnits</code> - The total number of capacity units consumed.</p></li>
/// </ul>
pub fn consumed_capacity(mut self, input: crate::types::ConsumedCapacity) -> Self {
let mut v = self.consumed_capacity.unwrap_or_default();
v.push(input);
self.consumed_capacity = ::std::option::Option::Some(v);
self
}
/// <p>The read capacity units consumed by the entire <code>BatchGetItem</code> operation.</p>
/// <p>Each element consists of:</p>
/// <ul>
/// <li>
/// <p><code>TableName</code> - The table that consumed the provisioned throughput.</p></li>
/// <li>
/// <p><code>CapacityUnits</code> - The total number of capacity units consumed.</p></li>
/// </ul>
pub fn set_consumed_capacity(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ConsumedCapacity>>) -> Self {
self.consumed_capacity = input;
self
}
/// <p>The read capacity units consumed by the entire <code>BatchGetItem</code> operation.</p>
/// <p>Each element consists of:</p>
/// <ul>
/// <li>
/// <p><code>TableName</code> - The table that consumed the provisioned throughput.</p></li>
/// <li>
/// <p><code>CapacityUnits</code> - The total number of capacity units consumed.</p></li>
/// </ul>
pub fn get_consumed_capacity(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ConsumedCapacity>> {
&self.consumed_capacity
}
pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
self._request_id = Some(request_id.into());
self
}
pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
self._request_id = request_id;
self
}
/// Consumes the builder and constructs a [`BatchGetItemOutput`](crate::operation::batch_get_item::BatchGetItemOutput).
pub fn build(self) -> crate::operation::batch_get_item::BatchGetItemOutput {
crate::operation::batch_get_item::BatchGetItemOutput {
responses: self.responses,
unprocessed_keys: self.unprocessed_keys,
consumed_capacity: self.consumed_capacity,
_request_id: self._request_id,
}
}
}