1 1 | // Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
|
2 - |
|
3 - | /// <p>Represents the properties of a global secondary index.</p>
|
2 + | /* StructureGenerator.kt:197 */
|
3 + | /// /* StructureGenerator.kt:197 */<p>Represents the properties of a global secondary index.</p>
|
4 + | /* RustType.kt:516 */
|
4 5 | #[non_exhaustive]
|
6 + | /* RustType.kt:516 */
|
5 7 | #[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
|
6 - | pub struct GlobalSecondaryIndexDescription {
|
7 - | /// <p>The name of the global secondary index.</p>
|
8 + | pub /* StructureGenerator.kt:201 */ struct GlobalSecondaryIndexDescription {
|
9 + | /// /* StructureGenerator.kt:231 */<p>The name of the global secondary index.</p>
|
8 10 | pub index_name: ::std::option::Option<::std::string::String>,
|
9 - | /// <p>The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:</p>
|
11 + | /// /* StructureGenerator.kt:231 */<p>The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:</p>
|
10 12 | /// <ul>
|
11 13 | /// <li>
|
12 14 | /// <p><code>HASH</code> - partition key</p></li>
|
13 15 | /// <li>
|
14 16 | /// <p><code>RANGE</code> - sort key</p></li>
|
15 17 | /// </ul><note>
|
16 18 | /// <p>The partition key of an item is also known as its <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.</p>
|
17 19 | /// <p>The sort key of an item is also known as its <i>range attribute</i>. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.</p>
|
18 20 | /// </note>
|
19 21 | pub key_schema: ::std::option::Option<::std::vec::Vec<crate::types::KeySchemaElement>>,
|
20 - | /// <p>Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.</p>
|
22 + | /// /* StructureGenerator.kt:231 */<p>Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.</p>
|
21 23 | pub projection: ::std::option::Option<crate::types::Projection>,
|
22 - | /// <p>The current state of the global secondary index:</p>
|
24 + | /// /* StructureGenerator.kt:231 */<p>The current state of the global secondary index:</p>
|
23 25 | /// <ul>
|
24 26 | /// <li>
|
25 27 | /// <p><code>CREATING</code> - The index is being created.</p></li>
|
26 28 | /// <li>
|
27 29 | /// <p><code>UPDATING</code> - The index is being updated.</p></li>
|
28 30 | /// <li>
|
29 31 | /// <p><code>DELETING</code> - The index is being deleted.</p></li>
|
30 32 | /// <li>
|
31 33 | /// <p><code>ACTIVE</code> - The index is ready for use.</p></li>
|
32 34 | /// </ul>
|
33 35 | pub index_status: ::std::option::Option<crate::types::IndexStatus>,
|
34 - | /// <p>Indicates whether the index is currently backfilling. <i>Backfilling</i> is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and <code>Backfilling</code> is false.</p>
|
36 + | /// /* StructureGenerator.kt:231 */<p>Indicates whether the index is currently backfilling. <i>Backfilling</i> is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and <code>Backfilling</code> is false.</p>
|
35 37 | /// <p>You can delete an index that is being created during the <code>Backfilling</code> phase when <code>IndexStatus</code> is set to CREATING and <code>Backfilling</code> is true. You can't delete the index that is being created when <code>IndexStatus</code> is set to CREATING and <code>Backfilling</code> is false.</p><note>
|
36 38 | /// <p>For indexes that were created during a <code>CreateTable</code> operation, the <code>Backfilling</code> attribute does not appear in the <code>DescribeTable</code> output.</p>
|
37 39 | /// </note>
|
38 40 | pub backfilling: ::std::option::Option<bool>,
|
39 - | /// <p>Represents the provisioned throughput settings for the specified global secondary index.</p>
|
41 + | /// /* StructureGenerator.kt:231 */<p>Represents the provisioned throughput settings for the specified global secondary index.</p>
|
40 42 | /// <p>For current minimum and maximum provisioned throughput values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service, Account, and Table Quotas</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
41 43 | pub provisioned_throughput: ::std::option::Option<crate::types::ProvisionedThroughputDescription>,
|
42 - | /// <p>The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>
|
44 + | /// /* StructureGenerator.kt:231 */<p>The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>
|
43 45 | pub index_size_bytes: i64,
|
44 - | /// <p>The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>
|
46 + | /// /* StructureGenerator.kt:231 */<p>The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>
|
45 47 | pub item_count: i64,
|
46 - | /// <p>The Amazon Resource Name (ARN) that uniquely identifies the index.</p>
|
48 + | /// /* StructureGenerator.kt:231 */<p>The Amazon Resource Name (ARN) that uniquely identifies the index.</p>
|
47 49 | pub index_arn: ::std::option::Option<::std::string::String>,
|
50 + | /* StructureGenerator.kt:201 */
|
48 51 | }
|
52 + | /* StructureGenerator.kt:135 */
|
49 53 | impl GlobalSecondaryIndexDescription {
|
50 - | /// <p>The name of the global secondary index.</p>
|
54 + | /// /* StructureGenerator.kt:231 */<p>The name of the global secondary index.</p>
|
55 + | /* StructureGenerator.kt:166 */
|
51 56 | pub fn index_name(&self) -> ::std::option::Option<&str> {
|
57 + | /* StructureGenerator.kt:169 */
|
52 58 | self.index_name.as_deref()
|
59 + | /* StructureGenerator.kt:166 */
|
53 60 | }
|
54 - | /// <p>The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:</p>
|
61 + | /// /* StructureGenerator.kt:231 */<p>The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:</p>
|
55 62 | /// <ul>
|
56 63 | /// <li>
|
57 64 | /// <p><code>HASH</code> - partition key</p></li>
|
58 65 | /// <li>
|
59 66 | /// <p><code>RANGE</code> - sort key</p></li>
|
60 67 | /// </ul><note>
|
61 68 | /// <p>The partition key of an item is also known as its <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.</p>
|
62 69 | /// <p>The sort key of an item is also known as its <i>range attribute</i>. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.</p>
|
63 70 | /// </note>
|
64 - | ///
|
65 - | /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.key_schema.is_none()`.
|
71 + | /// /* StructureGenerator.kt:162 */
|
72 + | /// /* StructureGenerator.kt:163 */If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.key_schema.is_none()`.
|
73 + | /* StructureGenerator.kt:166 */
|
66 74 | pub fn key_schema(&self) -> &[crate::types::KeySchemaElement] {
|
67 - | self.key_schema.as_deref().unwrap_or_default()
|
68 - | }
|
69 - | /// <p>Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.</p>
|
75 + | /* StructureGenerator.kt:169 */
|
76 + | self.key_schema
|
77 + | .as_deref()
|
78 + | /* StructureGenerator.kt:175 */
|
79 + | .unwrap_or_default()
|
80 + | /* StructureGenerator.kt:166 */
|
81 + | }
|
82 + | /// /* StructureGenerator.kt:231 */<p>Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.</p>
|
83 + | /* StructureGenerator.kt:166 */
|
70 84 | pub fn projection(&self) -> ::std::option::Option<&crate::types::Projection> {
|
85 + | /* StructureGenerator.kt:170 */
|
71 86 | self.projection.as_ref()
|
87 + | /* StructureGenerator.kt:166 */
|
72 88 | }
|
73 - | /// <p>The current state of the global secondary index:</p>
|
89 + | /// /* StructureGenerator.kt:231 */<p>The current state of the global secondary index:</p>
|
74 90 | /// <ul>
|
75 91 | /// <li>
|
76 92 | /// <p><code>CREATING</code> - The index is being created.</p></li>
|
77 93 | /// <li>
|
78 94 | /// <p><code>UPDATING</code> - The index is being updated.</p></li>
|
79 95 | /// <li>
|
80 96 | /// <p><code>DELETING</code> - The index is being deleted.</p></li>
|
81 97 | /// <li>
|
82 98 | /// <p><code>ACTIVE</code> - The index is ready for use.</p></li>
|
83 99 | /// </ul>
|
100 + | /* StructureGenerator.kt:166 */
|
84 101 | pub fn index_status(&self) -> ::std::option::Option<&crate::types::IndexStatus> {
|
102 + | /* StructureGenerator.kt:170 */
|
85 103 | self.index_status.as_ref()
|
104 + | /* StructureGenerator.kt:166 */
|
86 105 | }
|
87 - | /// <p>Indicates whether the index is currently backfilling. <i>Backfilling</i> is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and <code>Backfilling</code> is false.</p>
|
106 + | /// /* StructureGenerator.kt:231 */<p>Indicates whether the index is currently backfilling. <i>Backfilling</i> is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and <code>Backfilling</code> is false.</p>
|
88 107 | /// <p>You can delete an index that is being created during the <code>Backfilling</code> phase when <code>IndexStatus</code> is set to CREATING and <code>Backfilling</code> is true. You can't delete the index that is being created when <code>IndexStatus</code> is set to CREATING and <code>Backfilling</code> is false.</p><note>
|
89 108 | /// <p>For indexes that were created during a <code>CreateTable</code> operation, the <code>Backfilling</code> attribute does not appear in the <code>DescribeTable</code> output.</p>
|
90 109 | /// </note>
|
110 + | /* StructureGenerator.kt:166 */
|
91 111 | pub fn backfilling(&self) -> ::std::option::Option<bool> {
|
112 + | /* StructureGenerator.kt:168 */
|
92 113 | self.backfilling
|
114 + | /* StructureGenerator.kt:166 */
|
93 115 | }
|
94 - | /// <p>Represents the provisioned throughput settings for the specified global secondary index.</p>
|
116 + | /// /* StructureGenerator.kt:231 */<p>Represents the provisioned throughput settings for the specified global secondary index.</p>
|
95 117 | /// <p>For current minimum and maximum provisioned throughput values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service, Account, and Table Quotas</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
118 + | /* StructureGenerator.kt:166 */
|
96 119 | pub fn provisioned_throughput(&self) -> ::std::option::Option<&crate::types::ProvisionedThroughputDescription> {
|
120 + | /* StructureGenerator.kt:170 */
|
97 121 | self.provisioned_throughput.as_ref()
|
122 + | /* StructureGenerator.kt:166 */
|
98 123 | }
|
99 - | /// <p>The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>
|
124 + | /// /* StructureGenerator.kt:231 */<p>The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>
|
125 + | /* StructureGenerator.kt:166 */
|
100 126 | pub fn index_size_bytes(&self) -> i64 {
|
127 + | /* StructureGenerator.kt:168 */
|
101 128 | self.index_size_bytes
|
129 + | /* StructureGenerator.kt:166 */
|
102 130 | }
|
103 - | /// <p>The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>
|
131 + | /// /* StructureGenerator.kt:231 */<p>The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>
|
132 + | /* StructureGenerator.kt:166 */
|
104 133 | pub fn item_count(&self) -> i64 {
|
134 + | /* StructureGenerator.kt:168 */
|
105 135 | self.item_count
|
136 + | /* StructureGenerator.kt:166 */
|
106 137 | }
|
107 - | /// <p>The Amazon Resource Name (ARN) that uniquely identifies the index.</p>
|
138 + | /// /* StructureGenerator.kt:231 */<p>The Amazon Resource Name (ARN) that uniquely identifies the index.</p>
|
139 + | /* StructureGenerator.kt:166 */
|
108 140 | pub fn index_arn(&self) -> ::std::option::Option<&str> {
|
141 + | /* StructureGenerator.kt:169 */
|
109 142 | self.index_arn.as_deref()
|
143 + | /* StructureGenerator.kt:166 */
|
110 144 | }
|
145 + | /* StructureGenerator.kt:135 */
|
111 146 | }
|
147 + | /* ClientCodegenVisitor.kt:237 */
|
112 148 | impl GlobalSecondaryIndexDescription {
|
113 - | /// Creates a new builder-style object to manufacture [`GlobalSecondaryIndexDescription`](crate::types::GlobalSecondaryIndexDescription).
|
149 + | /// /* BuilderGenerator.kt:173 */Creates a new builder-style object to manufacture [`GlobalSecondaryIndexDescription`](crate::types::GlobalSecondaryIndexDescription).
|
150 + | /* BuilderGenerator.kt:175 */
|
114 151 | pub fn builder() -> crate::types::builders::GlobalSecondaryIndexDescriptionBuilder {
|
152 + | /* BuilderGenerator.kt:176 */
|
115 153 | crate::types::builders::GlobalSecondaryIndexDescriptionBuilder::default()
|
154 + | /* BuilderGenerator.kt:175 */
|
116 155 | }
|
156 + | /* ClientCodegenVisitor.kt:237 */
|
117 157 | }
|
118 158 |
|
119 - | /// A builder for [`GlobalSecondaryIndexDescription`](crate::types::GlobalSecondaryIndexDescription).
|
159 + | /// /* BuilderGenerator.kt:342 */A builder for [`GlobalSecondaryIndexDescription`](crate::types::GlobalSecondaryIndexDescription).
|
160 + | /* RustType.kt:516 */
|
120 161 | #[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
|
162 + | /* RustType.kt:516 */
|
121 163 | #[non_exhaustive]
|
164 + | /* BuilderGenerator.kt:345 */
|
122 165 | pub struct GlobalSecondaryIndexDescriptionBuilder {
|
123 - | pub(crate) index_name: ::std::option::Option<::std::string::String>,
|
124 - | pub(crate) key_schema: ::std::option::Option<::std::vec::Vec<crate::types::KeySchemaElement>>,
|
125 - | pub(crate) projection: ::std::option::Option<crate::types::Projection>,
|
126 - | pub(crate) index_status: ::std::option::Option<crate::types::IndexStatus>,
|
127 - | pub(crate) backfilling: ::std::option::Option<bool>,
|
128 - | pub(crate) provisioned_throughput: ::std::option::Option<crate::types::ProvisionedThroughputDescription>,
|
129 - | pub(crate) index_size_bytes: ::std::option::Option<i64>,
|
130 - | pub(crate) item_count: ::std::option::Option<i64>,
|
131 - | pub(crate) index_arn: ::std::option::Option<::std::string::String>,
|
166 + | /* BuilderGenerator.kt:275 */ pub(crate) index_name: ::std::option::Option<::std::string::String>,
|
167 + | /* BuilderGenerator.kt:275 */ pub(crate) key_schema: ::std::option::Option<::std::vec::Vec<crate::types::KeySchemaElement>>,
|
168 + | /* BuilderGenerator.kt:275 */ pub(crate) projection: ::std::option::Option<crate::types::Projection>,
|
169 + | /* BuilderGenerator.kt:275 */ pub(crate) index_status: ::std::option::Option<crate::types::IndexStatus>,
|
170 + | /* BuilderGenerator.kt:275 */ pub(crate) backfilling: ::std::option::Option<bool>,
|
171 + | /* BuilderGenerator.kt:275 */ pub(crate) provisioned_throughput: ::std::option::Option<crate::types::ProvisionedThroughputDescription>,
|
172 + | /* BuilderGenerator.kt:275 */ pub(crate) index_size_bytes: ::std::option::Option<i64>,
|
173 + | /* BuilderGenerator.kt:275 */ pub(crate) item_count: ::std::option::Option<i64>,
|
174 + | /* BuilderGenerator.kt:275 */ pub(crate) index_arn: ::std::option::Option<::std::string::String>,
|
175 + | /* BuilderGenerator.kt:345 */
|
132 176 | }
|
177 + | /* BuilderGenerator.kt:355 */
|
133 178 | impl GlobalSecondaryIndexDescriptionBuilder {
|
134 - | /// <p>The name of the global secondary index.</p>
|
179 + | /// /* BuilderGenerator.kt:286 */<p>The name of the global secondary index.</p>
|
180 + | /* BuilderGenerator.kt:291 */
|
135 181 | pub fn index_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
|
182 + | /* BuilderGenerator.kt:292 */
|
136 183 | self.index_name = ::std::option::Option::Some(input.into());
|
184 + | /* BuilderGenerator.kt:293 */
|
137 185 | self
|
186 + | /* BuilderGenerator.kt:291 */
|
138 187 | }
|
139 - | /// <p>The name of the global secondary index.</p>
|
188 + | /// /* BuilderGenerator.kt:312 */<p>The name of the global secondary index.</p>
|
189 + | /* BuilderGenerator.kt:314 */
|
140 190 | pub fn set_index_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
|
191 + | /* BuilderGenerator.kt:315 */
|
141 192 | self.index_name = input;
|
142 193 | self
|
194 + | /* BuilderGenerator.kt:314 */
|
143 195 | }
|
144 - | /// <p>The name of the global secondary index.</p>
|
196 + | /// /* BuilderGenerator.kt:334 */<p>The name of the global secondary index.</p>
|
197 + | /* BuilderGenerator.kt:336 */
|
145 198 | pub fn get_index_name(&self) -> &::std::option::Option<::std::string::String> {
|
199 + | /* BuilderGenerator.kt:337 */
|
146 200 | &self.index_name
|
201 + | /* BuilderGenerator.kt:336 */
|
147 202 | }
|
148 - | /// Appends an item to `key_schema`.
|
203 + | /// /* BuilderGenerator.kt:410 */Appends an item to `key_schema`.
|
204 + | /* BuilderGenerator.kt:411 */
|
149 205 | ///
|
150 - | /// To override the contents of this collection use [`set_key_schema`](Self::set_key_schema).
|
206 + | /// /* BuilderGenerator.kt:412 */To override the contents of this collection use [`set_key_schema`](Self::set_key_schema).
|
207 + | /* BuilderGenerator.kt:413 */
|
151 208 | ///
|
152 - | /// <p>The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:</p>
|
209 + | /// /* BuilderGenerator.kt:414 */<p>The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:</p>
|
153 210 | /// <ul>
|
154 211 | /// <li>
|
155 212 | /// <p><code>HASH</code> - partition key</p></li>
|
156 213 | /// <li>
|
157 214 | /// <p><code>RANGE</code> - sort key</p></li>
|
158 215 | /// </ul><note>
|
159 216 | /// <p>The partition key of an item is also known as its <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.</p>
|
160 217 | /// <p>The sort key of an item is also known as its <i>range attribute</i>. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.</p>
|
161 218 | /// </note>
|
219 + | /* BuilderGenerator.kt:418 */
|
162 220 | pub fn key_schema(mut self, input: crate::types::KeySchemaElement) -> Self {
|
221 + | /* BuilderGenerator.kt:419 */
|
163 222 | let mut v = self.key_schema.unwrap_or_default();
|
164 223 | v.push(input);
|
165 224 | self.key_schema = ::std::option::Option::Some(v);
|
166 225 | self
|
226 + | /* BuilderGenerator.kt:418 */
|
167 227 | }
|
168 - | /// <p>The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:</p>
|
228 + | /// /* BuilderGenerator.kt:312 */<p>The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:</p>
|
169 229 | /// <ul>
|
170 230 | /// <li>
|
171 231 | /// <p><code>HASH</code> - partition key</p></li>
|
172 232 | /// <li>
|
173 233 | /// <p><code>RANGE</code> - sort key</p></li>
|
174 234 | /// </ul><note>
|
175 235 | /// <p>The partition key of an item is also known as its <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.</p>
|
176 236 | /// <p>The sort key of an item is also known as its <i>range attribute</i>. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.</p>
|
177 237 | /// </note>
|
238 + | /* BuilderGenerator.kt:314 */
|
178 239 | pub fn set_key_schema(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::KeySchemaElement>>) -> Self {
|
240 + | /* BuilderGenerator.kt:315 */
|
179 241 | self.key_schema = input;
|
180 242 | self
|
243 + | /* BuilderGenerator.kt:314 */
|
181 244 | }
|
182 - | /// <p>The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:</p>
|
245 + | /// /* BuilderGenerator.kt:334 */<p>The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:</p>
|
183 246 | /// <ul>
|
184 247 | /// <li>
|
185 248 | /// <p><code>HASH</code> - partition key</p></li>
|
186 249 | /// <li>
|
187 250 | /// <p><code>RANGE</code> - sort key</p></li>
|
188 251 | /// </ul><note>
|
189 252 | /// <p>The partition key of an item is also known as its <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.</p>
|
190 253 | /// <p>The sort key of an item is also known as its <i>range attribute</i>. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.</p>
|
191 254 | /// </note>
|
255 + | /* BuilderGenerator.kt:336 */
|
192 256 | pub fn get_key_schema(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::KeySchemaElement>> {
|
257 + | /* BuilderGenerator.kt:337 */
|
193 258 | &self.key_schema
|
259 + | /* BuilderGenerator.kt:336 */
|
194 260 | }
|
195 - | /// <p>Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.</p>
|
261 + | /// /* BuilderGenerator.kt:286 */<p>Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.</p>
|
262 + | /* BuilderGenerator.kt:291 */
|
196 263 | pub fn projection(mut self, input: crate::types::Projection) -> Self {
|
264 + | /* BuilderGenerator.kt:292 */
|
197 265 | self.projection = ::std::option::Option::Some(input);
|
266 + | /* BuilderGenerator.kt:293 */
|
198 267 | self
|
268 + | /* BuilderGenerator.kt:291 */
|
199 269 | }
|
200 - | /// <p>Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.</p>
|
270 + | /// /* BuilderGenerator.kt:312 */<p>Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.</p>
|
271 + | /* BuilderGenerator.kt:314 */
|
201 272 | pub fn set_projection(mut self, input: ::std::option::Option<crate::types::Projection>) -> Self {
|
273 + | /* BuilderGenerator.kt:315 */
|
202 274 | self.projection = input;
|
203 275 | self
|
276 + | /* BuilderGenerator.kt:314 */
|
204 277 | }
|
205 - | /// <p>Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.</p>
|
278 + | /// /* BuilderGenerator.kt:334 */<p>Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.</p>
|
279 + | /* BuilderGenerator.kt:336 */
|
206 280 | pub fn get_projection(&self) -> &::std::option::Option<crate::types::Projection> {
|
281 + | /* BuilderGenerator.kt:337 */
|
207 282 | &self.projection
|
283 + | /* BuilderGenerator.kt:336 */
|
208 284 | }
|
209 - | /// <p>The current state of the global secondary index:</p>
|
285 + | /// /* BuilderGenerator.kt:286 */<p>The current state of the global secondary index:</p>
|
210 286 | /// <ul>
|
211 287 | /// <li>
|
212 288 | /// <p><code>CREATING</code> - The index is being created.</p></li>
|
213 289 | /// <li>
|
214 290 | /// <p><code>UPDATING</code> - The index is being updated.</p></li>
|
215 291 | /// <li>
|
216 292 | /// <p><code>DELETING</code> - The index is being deleted.</p></li>
|
217 293 | /// <li>
|
218 294 | /// <p><code>ACTIVE</code> - The index is ready for use.</p></li>
|
219 295 | /// </ul>
|
296 + | /* BuilderGenerator.kt:291 */
|
220 297 | pub fn index_status(mut self, input: crate::types::IndexStatus) -> Self {
|
298 + | /* BuilderGenerator.kt:292 */
|
221 299 | self.index_status = ::std::option::Option::Some(input);
|
300 + | /* BuilderGenerator.kt:293 */
|
222 301 | self
|
302 + | /* BuilderGenerator.kt:291 */
|
223 303 | }
|
224 - | /// <p>The current state of the global secondary index:</p>
|
304 + | /// /* BuilderGenerator.kt:312 */<p>The current state of the global secondary index:</p>
|
225 305 | /// <ul>
|
226 306 | /// <li>
|
227 307 | /// <p><code>CREATING</code> - The index is being created.</p></li>
|
228 308 | /// <li>
|
229 309 | /// <p><code>UPDATING</code> - The index is being updated.</p></li>
|
230 310 | /// <li>
|
231 311 | /// <p><code>DELETING</code> - The index is being deleted.</p></li>
|
232 312 | /// <li>
|
233 313 | /// <p><code>ACTIVE</code> - The index is ready for use.</p></li>
|
234 314 | /// </ul>
|
315 + | /* BuilderGenerator.kt:314 */
|
235 316 | pub fn set_index_status(mut self, input: ::std::option::Option<crate::types::IndexStatus>) -> Self {
|
317 + | /* BuilderGenerator.kt:315 */
|
236 318 | self.index_status = input;
|
237 319 | self
|
320 + | /* BuilderGenerator.kt:314 */
|
238 321 | }
|
239 - | /// <p>The current state of the global secondary index:</p>
|
322 + | /// /* BuilderGenerator.kt:334 */<p>The current state of the global secondary index:</p>
|
240 323 | /// <ul>
|
241 324 | /// <li>
|
242 325 | /// <p><code>CREATING</code> - The index is being created.</p></li>
|
243 326 | /// <li>
|
244 327 | /// <p><code>UPDATING</code> - The index is being updated.</p></li>
|
245 328 | /// <li>
|
246 329 | /// <p><code>DELETING</code> - The index is being deleted.</p></li>
|
247 330 | /// <li>
|
248 331 | /// <p><code>ACTIVE</code> - The index is ready for use.</p></li>
|
249 332 | /// </ul>
|
333 + | /* BuilderGenerator.kt:336 */
|
250 334 | pub fn get_index_status(&self) -> &::std::option::Option<crate::types::IndexStatus> {
|
335 + | /* BuilderGenerator.kt:337 */
|
251 336 | &self.index_status
|
337 + | /* BuilderGenerator.kt:336 */
|
252 338 | }
|
253 - | /// <p>Indicates whether the index is currently backfilling. <i>Backfilling</i> is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and <code>Backfilling</code> is false.</p>
|
339 + | /// /* BuilderGenerator.kt:286 */<p>Indicates whether the index is currently backfilling. <i>Backfilling</i> is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and <code>Backfilling</code> is false.</p>
|
254 340 | /// <p>You can delete an index that is being created during the <code>Backfilling</code> phase when <code>IndexStatus</code> is set to CREATING and <code>Backfilling</code> is true. You can't delete the index that is being created when <code>IndexStatus</code> is set to CREATING and <code>Backfilling</code> is false.</p><note>
|
255 341 | /// <p>For indexes that were created during a <code>CreateTable</code> operation, the <code>Backfilling</code> attribute does not appear in the <code>DescribeTable</code> output.</p>
|
256 342 | /// </note>
|
343 + | /* BuilderGenerator.kt:291 */
|
257 344 | pub fn backfilling(mut self, input: bool) -> Self {
|
345 + | /* BuilderGenerator.kt:292 */
|
258 346 | self.backfilling = ::std::option::Option::Some(input);
|
347 + | /* BuilderGenerator.kt:293 */
|
259 348 | self
|
349 + | /* BuilderGenerator.kt:291 */
|
260 350 | }
|
261 - | /// <p>Indicates whether the index is currently backfilling. <i>Backfilling</i> is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and <code>Backfilling</code> is false.</p>
|
351 + | /// /* BuilderGenerator.kt:312 */<p>Indicates whether the index is currently backfilling. <i>Backfilling</i> is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and <code>Backfilling</code> is false.</p>
|
262 352 | /// <p>You can delete an index that is being created during the <code>Backfilling</code> phase when <code>IndexStatus</code> is set to CREATING and <code>Backfilling</code> is true. You can't delete the index that is being created when <code>IndexStatus</code> is set to CREATING and <code>Backfilling</code> is false.</p><note>
|
263 353 | /// <p>For indexes that were created during a <code>CreateTable</code> operation, the <code>Backfilling</code> attribute does not appear in the <code>DescribeTable</code> output.</p>
|
264 354 | /// </note>
|
355 + | /* BuilderGenerator.kt:314 */
|
265 356 | pub fn set_backfilling(mut self, input: ::std::option::Option<bool>) -> Self {
|
357 + | /* BuilderGenerator.kt:315 */
|
266 358 | self.backfilling = input;
|
267 359 | self
|
360 + | /* BuilderGenerator.kt:314 */
|
268 361 | }
|
269 - | /// <p>Indicates whether the index is currently backfilling. <i>Backfilling</i> is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and <code>Backfilling</code> is false.</p>
|
362 + | /// /* BuilderGenerator.kt:334 */<p>Indicates whether the index is currently backfilling. <i>Backfilling</i> is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and <code>Backfilling</code> is false.</p>
|
270 363 | /// <p>You can delete an index that is being created during the <code>Backfilling</code> phase when <code>IndexStatus</code> is set to CREATING and <code>Backfilling</code> is true. You can't delete the index that is being created when <code>IndexStatus</code> is set to CREATING and <code>Backfilling</code> is false.</p><note>
|
271 364 | /// <p>For indexes that were created during a <code>CreateTable</code> operation, the <code>Backfilling</code> attribute does not appear in the <code>DescribeTable</code> output.</p>
|
272 365 | /// </note>
|
366 + | /* BuilderGenerator.kt:336 */
|
273 367 | pub fn get_backfilling(&self) -> &::std::option::Option<bool> {
|
368 + | /* BuilderGenerator.kt:337 */
|
274 369 | &self.backfilling
|
370 + | /* BuilderGenerator.kt:336 */
|
275 371 | }
|
276 - | /// <p>Represents the provisioned throughput settings for the specified global secondary index.</p>
|
372 + | /// /* BuilderGenerator.kt:286 */<p>Represents the provisioned throughput settings for the specified global secondary index.</p>
|
277 373 | /// <p>For current minimum and maximum provisioned throughput values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service, Account, and Table Quotas</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
374 + | /* BuilderGenerator.kt:291 */
|
278 375 | pub fn provisioned_throughput(mut self, input: crate::types::ProvisionedThroughputDescription) -> Self {
|
376 + | /* BuilderGenerator.kt:292 */
|
279 377 | self.provisioned_throughput = ::std::option::Option::Some(input);
|
378 + | /* BuilderGenerator.kt:293 */
|
280 379 | self
|
380 + | /* BuilderGenerator.kt:291 */
|
281 381 | }
|
282 - | /// <p>Represents the provisioned throughput settings for the specified global secondary index.</p>
|
382 + | /// /* BuilderGenerator.kt:312 */<p>Represents the provisioned throughput settings for the specified global secondary index.</p>
|
283 383 | /// <p>For current minimum and maximum provisioned throughput values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service, Account, and Table Quotas</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
384 + | /* BuilderGenerator.kt:314 */
|
284 385 | pub fn set_provisioned_throughput(mut self, input: ::std::option::Option<crate::types::ProvisionedThroughputDescription>) -> Self {
|
386 + | /* BuilderGenerator.kt:315 */
|
285 387 | self.provisioned_throughput = input;
|
286 388 | self
|
389 + | /* BuilderGenerator.kt:314 */
|
287 390 | }
|
288 - | /// <p>Represents the provisioned throughput settings for the specified global secondary index.</p>
|
391 + | /// /* BuilderGenerator.kt:334 */<p>Represents the provisioned throughput settings for the specified global secondary index.</p>
|
289 392 | /// <p>For current minimum and maximum provisioned throughput values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service, Account, and Table Quotas</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
393 + | /* BuilderGenerator.kt:336 */
|
290 394 | pub fn get_provisioned_throughput(&self) -> &::std::option::Option<crate::types::ProvisionedThroughputDescription> {
|
395 + | /* BuilderGenerator.kt:337 */
|
291 396 | &self.provisioned_throughput
|
397 + | /* BuilderGenerator.kt:336 */
|
292 398 | }
|
293 - | /// <p>The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>
|
399 + | /// /* BuilderGenerator.kt:286 */<p>The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>
|
400 + | /* BuilderGenerator.kt:291 */
|
294 401 | pub fn index_size_bytes(mut self, input: i64) -> Self {
|
402 + | /* BuilderGenerator.kt:292 */
|
295 403 | self.index_size_bytes = ::std::option::Option::Some(input);
|
404 + | /* BuilderGenerator.kt:293 */
|
296 405 | self
|
406 + | /* BuilderGenerator.kt:291 */
|
297 407 | }
|
298 - | /// <p>The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>
|
408 + | /// /* BuilderGenerator.kt:312 */<p>The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>
|
409 + | /* BuilderGenerator.kt:314 */
|
299 410 | pub fn set_index_size_bytes(mut self, input: ::std::option::Option<i64>) -> Self {
|
411 + | /* BuilderGenerator.kt:315 */
|
300 412 | self.index_size_bytes = input;
|
301 413 | self
|
414 + | /* BuilderGenerator.kt:314 */
|
302 415 | }
|
303 - | /// <p>The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>
|
416 + | /// /* BuilderGenerator.kt:334 */<p>The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>
|
417 + | /* BuilderGenerator.kt:336 */
|
304 418 | pub fn get_index_size_bytes(&self) -> &::std::option::Option<i64> {
|
419 + | /* BuilderGenerator.kt:337 */
|
305 420 | &self.index_size_bytes
|
421 + | /* BuilderGenerator.kt:336 */
|
306 422 | }
|
307 - | /// <p>The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>
|
423 + | /// /* BuilderGenerator.kt:286 */<p>The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>
|
424 + | /* BuilderGenerator.kt:291 */
|
308 425 | pub fn item_count(mut self, input: i64) -> Self {
|
426 + | /* BuilderGenerator.kt:292 */
|
309 427 | self.item_count = ::std::option::Option::Some(input);
|
428 + | /* BuilderGenerator.kt:293 */
|
310 429 | self
|
430 + | /* BuilderGenerator.kt:291 */
|
311 431 | }
|
312 - | /// <p>The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>
|
432 + | /// /* BuilderGenerator.kt:312 */<p>The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>
|
433 + | /* BuilderGenerator.kt:314 */
|
313 434 | pub fn set_item_count(mut self, input: ::std::option::Option<i64>) -> Self {
|
435 + | /* BuilderGenerator.kt:315 */
|
314 436 | self.item_count = input;
|
315 437 | self
|
438 + | /* BuilderGenerator.kt:314 */
|
316 439 | }
|
317 - | /// <p>The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>
|
440 + | /// /* BuilderGenerator.kt:334 */<p>The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>
|
441 + | /* BuilderGenerator.kt:336 */
|
318 442 | pub fn get_item_count(&self) -> &::std::option::Option<i64> {
|
443 + | /* BuilderGenerator.kt:337 */
|
319 444 | &self.item_count
|
445 + | /* BuilderGenerator.kt:336 */
|
320 446 | }
|
321 - | /// <p>The Amazon Resource Name (ARN) that uniquely identifies the index.</p>
|
447 + | /// /* BuilderGenerator.kt:286 */<p>The Amazon Resource Name (ARN) that uniquely identifies the index.</p>
|
448 + | /* BuilderGenerator.kt:291 */
|
322 449 | pub fn index_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
|
450 + | /* BuilderGenerator.kt:292 */
|
323 451 | self.index_arn = ::std::option::Option::Some(input.into());
|
452 + | /* BuilderGenerator.kt:293 */
|
324 453 | self
|
454 + | /* BuilderGenerator.kt:291 */
|
325 455 | }
|
326 - | /// <p>The Amazon Resource Name (ARN) that uniquely identifies the index.</p>
|
456 + | /// /* BuilderGenerator.kt:312 */<p>The Amazon Resource Name (ARN) that uniquely identifies the index.</p>
|
457 + | /* BuilderGenerator.kt:314 */
|
327 458 | pub fn set_index_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
|
459 + | /* BuilderGenerator.kt:315 */
|
328 460 | self.index_arn = input;
|
329 461 | self
|
462 + | /* BuilderGenerator.kt:314 */
|
330 463 | }
|
331 - | /// <p>The Amazon Resource Name (ARN) that uniquely identifies the index.</p>
|
464 + | /// /* BuilderGenerator.kt:334 */<p>The Amazon Resource Name (ARN) that uniquely identifies the index.</p>
|
465 + | /* BuilderGenerator.kt:336 */
|
332 466 | pub fn get_index_arn(&self) -> &::std::option::Option<::std::string::String> {
|
467 + | /* BuilderGenerator.kt:337 */
|
333 468 | &self.index_arn
|
469 + | /* BuilderGenerator.kt:336 */
|
334 470 | }
|
335 - | /// Consumes the builder and constructs a [`GlobalSecondaryIndexDescription`](crate::types::GlobalSecondaryIndexDescription).
|
471 + | /// /* BuilderGenerator.kt:240 */Consumes the builder and constructs a [`GlobalSecondaryIndexDescription`](crate::types::GlobalSecondaryIndexDescription).
|
472 + | /* BuilderGenerator.kt:253 */
|
336 473 | pub fn build(self) -> crate::types::GlobalSecondaryIndexDescription {
|
474 + | /* BuilderGenerator.kt:477 */
|
337 475 | crate::types::GlobalSecondaryIndexDescription {
|
338 - | index_name: self.index_name,
|
476 + | /* BuilderGenerator.kt:481 */ index_name: self.index_name,
|
477 + | /* BuilderGenerator.kt:481 */
|
339 478 | key_schema: self.key_schema,
|
479 + | /* BuilderGenerator.kt:481 */
|
340 480 | projection: self.projection,
|
481 + | /* BuilderGenerator.kt:481 */
|
341 482 | index_status: self.index_status,
|
483 + | /* BuilderGenerator.kt:481 */
|
342 484 | backfilling: self.backfilling,
|
485 + | /* BuilderGenerator.kt:481 */
|
343 486 | provisioned_throughput: self.provisioned_throughput,
|
344 - | index_size_bytes: self.index_size_bytes.unwrap_or_default(),
|
345 - | item_count: self.item_count.unwrap_or_default(),
|
487 + | /* BuilderGenerator.kt:481 */
|
488 + | index_size_bytes: self
|
489 + | .index_size_bytes
|
490 + | /* BuilderGenerator.kt:487 */
|
491 + | .unwrap_or_default(),
|
492 + | /* BuilderGenerator.kt:481 */
|
493 + | item_count: self
|
494 + | .item_count
|
495 + | /* BuilderGenerator.kt:487 */
|
496 + | .unwrap_or_default(),
|
497 + | /* BuilderGenerator.kt:481 */
|
346 498 | index_arn: self.index_arn,
|
499 + | /* BuilderGenerator.kt:477 */
|
347 500 | }
|
501 + | /* BuilderGenerator.kt:253 */
|
348 502 | }
|
503 + | /* BuilderGenerator.kt:355 */
|
349 504 | }
|