1 1 | // Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
|
2 - |
|
3 - | /// <p>Represents the input of an <code>UpdateItem</code> operation.</p>
|
2 + | /* StructureGenerator.kt:197 */
|
3 + | /// /* StructureGenerator.kt:197 */<p>Represents the input of an <code>UpdateItem</code> operation.</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 UpdateItemInput {
|
7 - | /// <p>The name of the table containing the item to update.</p>
|
8 + | pub /* StructureGenerator.kt:201 */ struct UpdateItemInput {
|
9 + | /// /* StructureGenerator.kt:231 */<p>The name of the table containing the item to update.</p>
|
8 10 | pub table_name: ::std::option::Option<::std::string::String>,
|
9 - | /// <p>The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.</p>
|
11 + | /// /* StructureGenerator.kt:231 */<p>The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.</p>
|
10 12 | /// <p>For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</p>
|
11 13 | pub key: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
|
12 - | /// <p>This is a legacy parameter. Use <code>UpdateExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html">AttributeUpdates</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
14 + | /// /* StructureGenerator.kt:231 */<p>This is a legacy parameter. Use <code>UpdateExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html">AttributeUpdates</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
13 15 | pub attribute_updates: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValueUpdate>>,
|
14 - | /// <p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html">Expected</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
16 + | /// /* StructureGenerator.kt:231 */<p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html">Expected</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
15 17 | pub expected: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::ExpectedAttributeValue>>,
|
16 - | /// <p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html">ConditionalOperator</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
18 + | /// /* StructureGenerator.kt:231 */<p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html">ConditionalOperator</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
17 19 | pub conditional_operator: ::std::option::Option<crate::types::ConditionalOperator>,
|
18 - | /// <p>Use <code>ReturnValues</code> if you want to get the item attributes as they appear before or after they are updated. For <code>UpdateItem</code>, the valid values are:</p>
|
20 + | /// /* StructureGenerator.kt:231 */<p>Use <code>ReturnValues</code> if you want to get the item attributes as they appear before or after they are updated. For <code>UpdateItem</code>, the valid values are:</p>
|
19 21 | /// <ul>
|
20 22 | /// <li>
|
21 23 | /// <p><code>NONE</code> - If <code>ReturnValues</code> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <code>ReturnValues</code>.)</p></li>
|
22 24 | /// <li>
|
23 25 | /// <p><code>ALL_OLD</code> - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.</p></li>
|
24 26 | /// <li>
|
25 27 | /// <p><code>UPDATED_OLD</code> - Returns only the updated attributes, as they appeared before the UpdateItem operation.</p></li>
|
26 28 | /// <li>
|
27 29 | /// <p><code>ALL_NEW</code> - Returns all of the attributes of the item, as they appear after the UpdateItem operation.</p></li>
|
28 30 | /// <li>
|
29 31 | /// <p><code>UPDATED_NEW</code> - Returns only the updated attributes, as they appear after the UpdateItem operation.</p></li>
|
30 32 | /// </ul>
|
31 33 | /// <p>There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.</p>
|
32 34 | /// <p>The values returned are strongly consistent.</p>
|
33 35 | pub return_values: ::std::option::Option<crate::types::ReturnValue>,
|
34 - | /// <p>Determines the level of detail about provisioned throughput consumption that is returned in the response:</p>
|
36 + | /// /* StructureGenerator.kt:231 */<p>Determines the level of detail about provisioned throughput consumption that is returned in the response:</p>
|
35 37 | /// <ul>
|
36 38 | /// <li>
|
37 39 | /// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
|
38 40 | /// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
|
39 41 | /// <li>
|
40 42 | /// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
|
41 43 | /// <li>
|
42 44 | /// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
|
43 45 | /// </ul>
|
44 46 | pub return_consumed_capacity: ::std::option::Option<crate::types::ReturnConsumedCapacity>,
|
45 - | /// <p>Determines whether item collection metrics are returned. If set to <code>SIZE</code>, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <code>NONE</code> (the default), no statistics are returned.</p>
|
47 + | /// /* StructureGenerator.kt:231 */<p>Determines whether item collection metrics are returned. If set to <code>SIZE</code>, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <code>NONE</code> (the default), no statistics are returned.</p>
|
46 48 | pub return_item_collection_metrics: ::std::option::Option<crate::types::ReturnItemCollectionMetrics>,
|
47 - | /// <p>An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.</p>
|
49 + | /// /* StructureGenerator.kt:231 */<p>An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.</p>
|
48 50 | /// <p>The following action values are available for <code>UpdateExpression</code>.</p>
|
49 51 | /// <ul>
|
50 52 | /// <li>
|
51 53 | /// <p><code>SET</code> - Adds one or more attributes and values to an item. If any of these attributes already exist, they are replaced by the new values. You can also use <code>SET</code> to add or subtract from an attribute that is of type Number. For example: <code>SET myNum = myNum + :val</code></p>
|
52 54 | /// <p><code>SET</code> supports the following functions:</p>
|
53 55 | /// <ul>
|
54 56 | /// <li>
|
55 57 | /// <p><code>if_not_exists (path, operand)</code> - if the item does not contain an attribute at the specified path, then <code>if_not_exists</code> evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.</p></li>
|
56 58 | /// <li>
|
57 59 | /// <p><code>list_append (operand, operand)</code> - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.</p></li>
|
58 60 | /// </ul>
|
59 61 | /// <p>These function names are case-sensitive.</p></li>
|
60 62 | /// <li>
|
61 63 | /// <p><code>REMOVE</code> - Removes one or more attributes from an item.</p></li>
|
62 64 | /// <li>
|
63 65 | /// <p><code>ADD</code> - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of <code>ADD</code> depends on the data type of the attribute:</p>
|
64 66 | /// <ul>
|
65 67 | /// <li>
|
66 68 | /// <p>If the existing attribute is a number, and if <code>Value</code> is also a number, then <code>Value</code> is mathematically added to the existing attribute. If <code>Value</code> is a negative number, then it is subtracted from the existing attribute.</p><note>
|
67 69 | /// <p>If you use <code>ADD</code> to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value.</p>
|
68 70 | /// <p>Similarly, if you use <code>ADD</code> for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value. For example, suppose that the item you want to update doesn't have an attribute named <code>itemcount</code>, but you decide to <code>ADD</code> the number <code>3</code> to this attribute anyway. DynamoDB will create the <code>itemcount</code> attribute, set its initial value to <code>0</code>, and finally add <code>3</code> to it. The result will be a new <code>itemcount</code> attribute in the item, with a value of <code>3</code>.</p>
|
69 71 | /// </note></li>
|
70 72 | /// <li>
|
71 73 | /// <p>If the existing data type is a set and if <code>Value</code> is also a set, then <code>Value</code> is added to the existing set. For example, if the attribute value is the set <code>\[1,2\]</code>, and the <code>ADD</code> action specified <code>\[3\]</code>, then the final attribute value is <code>\[1,2,3\]</code>. An error occurs if an <code>ADD</code> action is specified for a set attribute and the attribute type specified does not match the existing set type.</p>
|
72 74 | /// <p>Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the <code>Value</code> must also be a set of strings.</p></li>
|
73 75 | /// </ul><important>
|
74 76 | /// <p>The <code>ADD</code> action only supports Number and set data types. In addition, <code>ADD</code> can only be used on top-level attributes, not nested attributes.</p>
|
75 77 | /// </important></li>
|
76 78 | /// <li>
|
77 79 | /// <p><code>DELETE</code> - Deletes an element from a set.</p>
|
78 80 | /// <p>If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set <code>\[a,b,c\]</code> and the <code>DELETE</code> action specifies <code>\[a,c\]</code>, then the final attribute value is <code>\[b\]</code>. Specifying an empty set is an error.</p><important>
|
79 81 | /// <p>The <code>DELETE</code> action only supports set data types. In addition, <code>DELETE</code> can only be used on top-level attributes, not nested attributes.</p>
|
80 82 | /// </important></li>
|
81 83 | /// </ul>
|
82 84 | /// <p>You can have many actions in a single expression, such as the following: <code>SET a=:value1, b=:value2 DELETE :value3, :value4, :value5</code></p>
|
83 85 | /// <p>For more information on update expressions, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Modifying.html">Modifying Items and Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
84 86 | pub update_expression: ::std::option::Option<::std::string::String>,
|
85 - | /// <p>A condition that must be satisfied in order for a conditional update to succeed.</p>
|
87 + | /// /* StructureGenerator.kt:231 */<p>A condition that must be satisfied in order for a conditional update to succeed.</p>
|
86 88 | /// <p>An expression can contain any of the following:</p>
|
87 89 | /// <ul>
|
88 90 | /// <li>
|
89 91 | /// <p>Functions: <code>attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size</code></p>
|
90 92 | /// <p>These function names are case-sensitive.</p></li>
|
91 93 | /// <li>
|
92 94 | /// <p>Comparison operators: <code>= | <> | < | > | <= | >= | BETWEEN | IN </code></p></li>
|
93 95 | /// <li>
|
94 96 | /// <p>Logical operators: <code>AND | OR | NOT</code></p></li>
|
95 97 | /// </ul>
|
96 98 | /// <p>For more information about condition expressions, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Specifying Conditions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
97 99 | pub condition_expression: ::std::option::Option<::std::string::String>,
|
98 - | /// <p>One or more substitution tokens for attribute names in an expression. The following are some use cases for using <code>ExpressionAttributeNames</code>:</p>
|
100 + | /// /* StructureGenerator.kt:231 */<p>One or more substitution tokens for attribute names in an expression. The following are some use cases for using <code>ExpressionAttributeNames</code>:</p>
|
99 101 | /// <ul>
|
100 102 | /// <li>
|
101 103 | /// <p>To access an attribute whose name conflicts with a DynamoDB reserved word.</p></li>
|
102 104 | /// <li>
|
103 105 | /// <p>To create a placeholder for repeating occurrences of an attribute name in an expression.</p></li>
|
104 106 | /// <li>
|
105 107 | /// <p>To prevent special characters in an attribute name from being misinterpreted in an expression.</p></li>
|
106 108 | /// </ul>
|
107 109 | /// <p>Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name:</p>
|
108 110 | /// <ul>
|
109 111 | /// <li>
|
110 112 | /// <p><code>Percentile</code></p></li>
|
111 113 | /// </ul>
|
112 114 | /// <p>The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>.) To work around this, you could specify the following for <code>ExpressionAttributeNames</code>:</p>
|
113 115 | /// <ul>
|
114 116 | /// <li>
|
115 117 | /// <p><code>{"#P":"Percentile"}</code></p></li>
|
116 118 | /// </ul>
|
117 119 | /// <p>You could then use this substitution in an expression, as in this example:</p>
|
118 120 | /// <ul>
|
119 121 | /// <li>
|
120 122 | /// <p><code>#P = :val</code></p></li>
|
121 123 | /// </ul><note>
|
122 124 | /// <p>Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime.</p>
|
123 125 | /// </note>
|
124 126 | /// <p>For more information about expression attribute names, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
125 127 | pub expression_attribute_names: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
|
126 - | /// <p>One or more values that can be substituted in an expression.</p>
|
128 + | /// /* StructureGenerator.kt:231 */<p>One or more values that can be substituted in an expression.</p>
|
127 129 | /// <p>Use the <b>:</b> (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the <code>ProductStatus</code> attribute was one of the following:</p>
|
128 130 | /// <p><code>Available | Backordered | Discontinued</code></p>
|
129 131 | /// <p>You would first need to specify <code>ExpressionAttributeValues</code> as follows:</p>
|
130 132 | /// <p><code>{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }</code></p>
|
131 133 | /// <p>You could then use these values in an expression, such as this:</p>
|
132 134 | /// <p><code>ProductStatus IN (:avail, :back, :disc)</code></p>
|
133 135 | /// <p>For more information on expression attribute values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Condition Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
134 136 | pub expression_attribute_values: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
|
137 + | /* StructureGenerator.kt:201 */
|
135 138 | }
|
139 + | /* StructureGenerator.kt:135 */
|
136 140 | impl UpdateItemInput {
|
137 - | /// <p>The name of the table containing the item to update.</p>
|
141 + | /// /* StructureGenerator.kt:231 */<p>The name of the table containing the item to update.</p>
|
142 + | /* StructureGenerator.kt:166 */
|
138 143 | pub fn table_name(&self) -> ::std::option::Option<&str> {
|
144 + | /* StructureGenerator.kt:169 */
|
139 145 | self.table_name.as_deref()
|
146 + | /* StructureGenerator.kt:166 */
|
140 147 | }
|
141 - | /// <p>The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.</p>
|
148 + | /// /* StructureGenerator.kt:231 */<p>The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.</p>
|
142 149 | /// <p>For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</p>
|
150 + | /* StructureGenerator.kt:166 */
|
143 151 | pub fn key(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>> {
|
152 + | /* StructureGenerator.kt:170 */
|
144 153 | self.key.as_ref()
|
154 + | /* StructureGenerator.kt:166 */
|
145 155 | }
|
146 - | /// <p>This is a legacy parameter. Use <code>UpdateExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html">AttributeUpdates</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
156 + | /// /* StructureGenerator.kt:231 */<p>This is a legacy parameter. Use <code>UpdateExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html">AttributeUpdates</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
157 + | /* StructureGenerator.kt:166 */
|
147 158 | pub fn attribute_updates(
|
148 159 | &self,
|
149 160 | ) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, crate::types::AttributeValueUpdate>> {
|
161 + | /* StructureGenerator.kt:170 */
|
150 162 | self.attribute_updates.as_ref()
|
163 + | /* StructureGenerator.kt:166 */
|
151 164 | }
|
152 - | /// <p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html">Expected</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
165 + | /// /* StructureGenerator.kt:231 */<p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html">Expected</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
166 + | /* StructureGenerator.kt:166 */
|
153 167 | pub fn expected(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, crate::types::ExpectedAttributeValue>> {
|
168 + | /* StructureGenerator.kt:170 */
|
154 169 | self.expected.as_ref()
|
170 + | /* StructureGenerator.kt:166 */
|
155 171 | }
|
156 - | /// <p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html">ConditionalOperator</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
172 + | /// /* StructureGenerator.kt:231 */<p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html">ConditionalOperator</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
173 + | /* StructureGenerator.kt:166 */
|
157 174 | pub fn conditional_operator(&self) -> ::std::option::Option<&crate::types::ConditionalOperator> {
|
175 + | /* StructureGenerator.kt:170 */
|
158 176 | self.conditional_operator.as_ref()
|
177 + | /* StructureGenerator.kt:166 */
|
159 178 | }
|
160 - | /// <p>Use <code>ReturnValues</code> if you want to get the item attributes as they appear before or after they are updated. For <code>UpdateItem</code>, the valid values are:</p>
|
179 + | /// /* StructureGenerator.kt:231 */<p>Use <code>ReturnValues</code> if you want to get the item attributes as they appear before or after they are updated. For <code>UpdateItem</code>, the valid values are:</p>
|
161 180 | /// <ul>
|
162 181 | /// <li>
|
163 182 | /// <p><code>NONE</code> - If <code>ReturnValues</code> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <code>ReturnValues</code>.)</p></li>
|
164 183 | /// <li>
|
165 184 | /// <p><code>ALL_OLD</code> - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.</p></li>
|
166 185 | /// <li>
|
167 186 | /// <p><code>UPDATED_OLD</code> - Returns only the updated attributes, as they appeared before the UpdateItem operation.</p></li>
|
168 187 | /// <li>
|
169 188 | /// <p><code>ALL_NEW</code> - Returns all of the attributes of the item, as they appear after the UpdateItem operation.</p></li>
|
170 189 | /// <li>
|
171 190 | /// <p><code>UPDATED_NEW</code> - Returns only the updated attributes, as they appear after the UpdateItem operation.</p></li>
|
172 191 | /// </ul>
|
173 192 | /// <p>There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.</p>
|
174 193 | /// <p>The values returned are strongly consistent.</p>
|
194 + | /* StructureGenerator.kt:166 */
|
175 195 | pub fn return_values(&self) -> ::std::option::Option<&crate::types::ReturnValue> {
|
196 + | /* StructureGenerator.kt:170 */
|
176 197 | self.return_values.as_ref()
|
198 + | /* StructureGenerator.kt:166 */
|
177 199 | }
|
178 - | /// <p>Determines the level of detail about provisioned throughput consumption that is returned in the response:</p>
|
200 + | /// /* StructureGenerator.kt:231 */<p>Determines the level of detail about provisioned throughput consumption that is returned in the response:</p>
|
179 201 | /// <ul>
|
180 202 | /// <li>
|
181 203 | /// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
|
182 204 | /// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
|
183 205 | /// <li>
|
184 206 | /// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
|
185 207 | /// <li>
|
186 208 | /// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
|
187 209 | /// </ul>
|
210 + | /* StructureGenerator.kt:166 */
|
188 211 | pub fn return_consumed_capacity(&self) -> ::std::option::Option<&crate::types::ReturnConsumedCapacity> {
|
212 + | /* StructureGenerator.kt:170 */
|
189 213 | self.return_consumed_capacity.as_ref()
|
214 + | /* StructureGenerator.kt:166 */
|
190 215 | }
|
191 - | /// <p>Determines whether item collection metrics are returned. If set to <code>SIZE</code>, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <code>NONE</code> (the default), no statistics are returned.</p>
|
216 + | /// /* StructureGenerator.kt:231 */<p>Determines whether item collection metrics are returned. If set to <code>SIZE</code>, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <code>NONE</code> (the default), no statistics are returned.</p>
|
217 + | /* StructureGenerator.kt:166 */
|
192 218 | pub fn return_item_collection_metrics(&self) -> ::std::option::Option<&crate::types::ReturnItemCollectionMetrics> {
|
219 + | /* StructureGenerator.kt:170 */
|
193 220 | self.return_item_collection_metrics.as_ref()
|
221 + | /* StructureGenerator.kt:166 */
|
194 222 | }
|
195 - | /// <p>An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.</p>
|
223 + | /// /* StructureGenerator.kt:231 */<p>An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.</p>
|
196 224 | /// <p>The following action values are available for <code>UpdateExpression</code>.</p>
|
197 225 | /// <ul>
|
198 226 | /// <li>
|
199 227 | /// <p><code>SET</code> - Adds one or more attributes and values to an item. If any of these attributes already exist, they are replaced by the new values. You can also use <code>SET</code> to add or subtract from an attribute that is of type Number. For example: <code>SET myNum = myNum + :val</code></p>
|
200 228 | /// <p><code>SET</code> supports the following functions:</p>
|
201 229 | /// <ul>
|
202 230 | /// <li>
|
203 231 | /// <p><code>if_not_exists (path, operand)</code> - if the item does not contain an attribute at the specified path, then <code>if_not_exists</code> evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.</p></li>
|
204 232 | /// <li>
|
205 233 | /// <p><code>list_append (operand, operand)</code> - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.</p></li>
|
206 234 | /// </ul>
|
207 235 | /// <p>These function names are case-sensitive.</p></li>
|
208 236 | /// <li>
|
209 237 | /// <p><code>REMOVE</code> - Removes one or more attributes from an item.</p></li>
|
210 238 | /// <li>
|
211 239 | /// <p><code>ADD</code> - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of <code>ADD</code> depends on the data type of the attribute:</p>
|
212 240 | /// <ul>
|
213 241 | /// <li>
|
214 242 | /// <p>If the existing attribute is a number, and if <code>Value</code> is also a number, then <code>Value</code> is mathematically added to the existing attribute. If <code>Value</code> is a negative number, then it is subtracted from the existing attribute.</p><note>
|
215 243 | /// <p>If you use <code>ADD</code> to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value.</p>
|
216 244 | /// <p>Similarly, if you use <code>ADD</code> for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value. For example, suppose that the item you want to update doesn't have an attribute named <code>itemcount</code>, but you decide to <code>ADD</code> the number <code>3</code> to this attribute anyway. DynamoDB will create the <code>itemcount</code> attribute, set its initial value to <code>0</code>, and finally add <code>3</code> to it. The result will be a new <code>itemcount</code> attribute in the item, with a value of <code>3</code>.</p>
|
217 245 | /// </note></li>
|
218 246 | /// <li>
|
219 247 | /// <p>If the existing data type is a set and if <code>Value</code> is also a set, then <code>Value</code> is added to the existing set. For example, if the attribute value is the set <code>\[1,2\]</code>, and the <code>ADD</code> action specified <code>\[3\]</code>, then the final attribute value is <code>\[1,2,3\]</code>. An error occurs if an <code>ADD</code> action is specified for a set attribute and the attribute type specified does not match the existing set type.</p>
|
220 248 | /// <p>Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the <code>Value</code> must also be a set of strings.</p></li>
|
221 249 | /// </ul><important>
|
222 250 | /// <p>The <code>ADD</code> action only supports Number and set data types. In addition, <code>ADD</code> can only be used on top-level attributes, not nested attributes.</p>
|
223 251 | /// </important></li>
|
224 252 | /// <li>
|
225 253 | /// <p><code>DELETE</code> - Deletes an element from a set.</p>
|
226 254 | /// <p>If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set <code>\[a,b,c\]</code> and the <code>DELETE</code> action specifies <code>\[a,c\]</code>, then the final attribute value is <code>\[b\]</code>. Specifying an empty set is an error.</p><important>
|
227 255 | /// <p>The <code>DELETE</code> action only supports set data types. In addition, <code>DELETE</code> can only be used on top-level attributes, not nested attributes.</p>
|
228 256 | /// </important></li>
|
229 257 | /// </ul>
|
230 258 | /// <p>You can have many actions in a single expression, such as the following: <code>SET a=:value1, b=:value2 DELETE :value3, :value4, :value5</code></p>
|
231 259 | /// <p>For more information on update expressions, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Modifying.html">Modifying Items and Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
260 + | /* StructureGenerator.kt:166 */
|
232 261 | pub fn update_expression(&self) -> ::std::option::Option<&str> {
|
262 + | /* StructureGenerator.kt:169 */
|
233 263 | self.update_expression.as_deref()
|
264 + | /* StructureGenerator.kt:166 */
|
234 265 | }
|
235 - | /// <p>A condition that must be satisfied in order for a conditional update to succeed.</p>
|
266 + | /// /* StructureGenerator.kt:231 */<p>A condition that must be satisfied in order for a conditional update to succeed.</p>
|
236 267 | /// <p>An expression can contain any of the following:</p>
|
237 268 | /// <ul>
|
238 269 | /// <li>
|
239 270 | /// <p>Functions: <code>attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size</code></p>
|
240 271 | /// <p>These function names are case-sensitive.</p></li>
|
241 272 | /// <li>
|
242 273 | /// <p>Comparison operators: <code>= | <> | < | > | <= | >= | BETWEEN | IN </code></p></li>
|
243 274 | /// <li>
|
244 275 | /// <p>Logical operators: <code>AND | OR | NOT</code></p></li>
|
245 276 | /// </ul>
|
246 277 | /// <p>For more information about condition expressions, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Specifying Conditions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
278 + | /* StructureGenerator.kt:166 */
|
247 279 | pub fn condition_expression(&self) -> ::std::option::Option<&str> {
|
280 + | /* StructureGenerator.kt:169 */
|
248 281 | self.condition_expression.as_deref()
|
282 + | /* StructureGenerator.kt:166 */
|
249 283 | }
|
250 - | /// <p>One or more substitution tokens for attribute names in an expression. The following are some use cases for using <code>ExpressionAttributeNames</code>:</p>
|
284 + | /// /* StructureGenerator.kt:231 */<p>One or more substitution tokens for attribute names in an expression. The following are some use cases for using <code>ExpressionAttributeNames</code>:</p>
|
251 285 | /// <ul>
|
252 286 | /// <li>
|
253 287 | /// <p>To access an attribute whose name conflicts with a DynamoDB reserved word.</p></li>
|
254 288 | /// <li>
|
255 289 | /// <p>To create a placeholder for repeating occurrences of an attribute name in an expression.</p></li>
|
256 290 | /// <li>
|
257 291 | /// <p>To prevent special characters in an attribute name from being misinterpreted in an expression.</p></li>
|
258 292 | /// </ul>
|
259 293 | /// <p>Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name:</p>
|
260 294 | /// <ul>
|
261 295 | /// <li>
|
262 296 | /// <p><code>Percentile</code></p></li>
|
263 297 | /// </ul>
|
264 298 | /// <p>The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>.) To work around this, you could specify the following for <code>ExpressionAttributeNames</code>:</p>
|
265 299 | /// <ul>
|
266 300 | /// <li>
|
267 301 | /// <p><code>{"#P":"Percentile"}</code></p></li>
|
268 302 | /// </ul>
|
269 303 | /// <p>You could then use this substitution in an expression, as in this example:</p>
|
270 304 | /// <ul>
|
271 305 | /// <li>
|
272 306 | /// <p><code>#P = :val</code></p></li>
|
273 307 | /// </ul><note>
|
274 308 | /// <p>Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime.</p>
|
275 309 | /// </note>
|
276 310 | /// <p>For more information about expression attribute names, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
311 + | /* StructureGenerator.kt:166 */
|
277 312 | pub fn expression_attribute_names(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
|
313 + | /* StructureGenerator.kt:170 */
|
278 314 | self.expression_attribute_names.as_ref()
|
315 + | /* StructureGenerator.kt:166 */
|
279 316 | }
|
280 - | /// <p>One or more values that can be substituted in an expression.</p>
|
317 + | /// /* StructureGenerator.kt:231 */<p>One or more values that can be substituted in an expression.</p>
|
281 318 | /// <p>Use the <b>:</b> (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the <code>ProductStatus</code> attribute was one of the following:</p>
|
282 319 | /// <p><code>Available | Backordered | Discontinued</code></p>
|
283 320 | /// <p>You would first need to specify <code>ExpressionAttributeValues</code> as follows:</p>
|
284 321 | /// <p><code>{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }</code></p>
|
285 322 | /// <p>You could then use these values in an expression, such as this:</p>
|
286 323 | /// <p><code>ProductStatus IN (:avail, :back, :disc)</code></p>
|
287 324 | /// <p>For more information on expression attribute values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Condition Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
325 + | /* StructureGenerator.kt:166 */
|
288 326 | pub fn expression_attribute_values(
|
289 327 | &self,
|
290 328 | ) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>> {
|
329 + | /* StructureGenerator.kt:170 */
|
291 330 | self.expression_attribute_values.as_ref()
|
331 + | /* StructureGenerator.kt:166 */
|
292 332 | }
|
333 + | /* StructureGenerator.kt:135 */
|
293 334 | }
|
335 + | /* ClientCodegenVisitor.kt:237 */
|
294 336 | impl UpdateItemInput {
|
295 - | /// Creates a new builder-style object to manufacture [`UpdateItemInput`](crate::operation::update_item::UpdateItemInput).
|
337 + | /// /* BuilderGenerator.kt:173 */Creates a new builder-style object to manufacture [`UpdateItemInput`](crate::operation::update_item::UpdateItemInput).
|
338 + | /* BuilderGenerator.kt:175 */
|
296 339 | pub fn builder() -> crate::operation::update_item::builders::UpdateItemInputBuilder {
|
340 + | /* BuilderGenerator.kt:176 */
|
297 341 | crate::operation::update_item::builders::UpdateItemInputBuilder::default()
|
342 + | /* BuilderGenerator.kt:175 */
|
298 343 | }
|
344 + | /* ClientCodegenVisitor.kt:237 */
|
299 345 | }
|
300 346 |
|
301 - | /// A builder for [`UpdateItemInput`](crate::operation::update_item::UpdateItemInput).
|
347 + | /// /* BuilderGenerator.kt:342 */A builder for [`UpdateItemInput`](crate::operation::update_item::UpdateItemInput).
|
348 + | /* RustType.kt:516 */
|
302 349 | #[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
|
350 + | /* RustType.kt:516 */
|
303 351 | #[non_exhaustive]
|
352 + | /* BuilderGenerator.kt:345 */
|
304 353 | pub struct UpdateItemInputBuilder {
|
305 - | pub(crate) table_name: ::std::option::Option<::std::string::String>,
|
354 + | /* BuilderGenerator.kt:275 */ pub(crate) table_name: ::std::option::Option<::std::string::String>,
|
355 + | /* BuilderGenerator.kt:275 */
|
306 356 | pub(crate) key: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
|
357 + | /* BuilderGenerator.kt:275 */
|
307 358 | pub(crate) attribute_updates: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValueUpdate>>,
|
359 + | /* BuilderGenerator.kt:275 */
|
308 360 | pub(crate) expected: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::ExpectedAttributeValue>>,
|
309 - | pub(crate) conditional_operator: ::std::option::Option<crate::types::ConditionalOperator>,
|
310 - | pub(crate) return_values: ::std::option::Option<crate::types::ReturnValue>,
|
311 - | pub(crate) return_consumed_capacity: ::std::option::Option<crate::types::ReturnConsumedCapacity>,
|
312 - | pub(crate) return_item_collection_metrics: ::std::option::Option<crate::types::ReturnItemCollectionMetrics>,
|
313 - | pub(crate) update_expression: ::std::option::Option<::std::string::String>,
|
314 - | pub(crate) condition_expression: ::std::option::Option<::std::string::String>,
|
361 + | /* BuilderGenerator.kt:275 */ pub(crate) conditional_operator: ::std::option::Option<crate::types::ConditionalOperator>,
|
362 + | /* BuilderGenerator.kt:275 */ pub(crate) return_values: ::std::option::Option<crate::types::ReturnValue>,
|
363 + | /* BuilderGenerator.kt:275 */ pub(crate) return_consumed_capacity: ::std::option::Option<crate::types::ReturnConsumedCapacity>,
|
364 + | /* BuilderGenerator.kt:275 */ pub(crate) return_item_collection_metrics: ::std::option::Option<crate::types::ReturnItemCollectionMetrics>,
|
365 + | /* BuilderGenerator.kt:275 */ pub(crate) update_expression: ::std::option::Option<::std::string::String>,
|
366 + | /* BuilderGenerator.kt:275 */ pub(crate) condition_expression: ::std::option::Option<::std::string::String>,
|
367 + | /* BuilderGenerator.kt:275 */
|
315 368 | pub(crate) expression_attribute_names: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
|
369 + | /* BuilderGenerator.kt:275 */
|
316 370 | pub(crate) expression_attribute_values: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
|
371 + | /* BuilderGenerator.kt:345 */
|
317 372 | }
|
373 + | /* BuilderGenerator.kt:355 */
|
318 374 | impl UpdateItemInputBuilder {
|
319 - | /// <p>The name of the table containing the item to update.</p>
|
320 - | /// This field is required.
|
375 + | /// /* BuilderGenerator.kt:286 */<p>The name of the table containing the item to update.</p>
|
376 + | /// /* BuilderGenerator.kt:288 */This field is required.
|
377 + | /* BuilderGenerator.kt:291 */
|
321 378 | pub fn table_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
|
379 + | /* BuilderGenerator.kt:292 */
|
322 380 | self.table_name = ::std::option::Option::Some(input.into());
|
381 + | /* BuilderGenerator.kt:293 */
|
323 382 | self
|
383 + | /* BuilderGenerator.kt:291 */
|
324 384 | }
|
325 - | /// <p>The name of the table containing the item to update.</p>
|
385 + | /// /* BuilderGenerator.kt:312 */<p>The name of the table containing the item to update.</p>
|
386 + | /* BuilderGenerator.kt:314 */
|
326 387 | pub fn set_table_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
|
388 + | /* BuilderGenerator.kt:315 */
|
327 389 | self.table_name = input;
|
328 390 | self
|
391 + | /* BuilderGenerator.kt:314 */
|
329 392 | }
|
330 - | /// <p>The name of the table containing the item to update.</p>
|
393 + | /// /* BuilderGenerator.kt:334 */<p>The name of the table containing the item to update.</p>
|
394 + | /* BuilderGenerator.kt:336 */
|
331 395 | pub fn get_table_name(&self) -> &::std::option::Option<::std::string::String> {
|
396 + | /* BuilderGenerator.kt:337 */
|
332 397 | &self.table_name
|
398 + | /* BuilderGenerator.kt:336 */
|
333 399 | }
|
334 - | /// Adds a key-value pair to `key`.
|
400 + | /// /* BuilderGenerator.kt:436 */Adds a key-value pair to `key`.
|
401 + | /* BuilderGenerator.kt:437 */
|
335 402 | ///
|
336 - | /// To override the contents of this collection use [`set_key`](Self::set_key).
|
403 + | /// /* BuilderGenerator.kt:438 */To override the contents of this collection use [`set_key`](Self::set_key).
|
404 + | /* BuilderGenerator.kt:439 */
|
337 405 | ///
|
338 - | /// <p>The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.</p>
|
406 + | /// /* BuilderGenerator.kt:440 */<p>The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.</p>
|
339 407 | /// <p>For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</p>
|
408 + | /* BuilderGenerator.kt:445 */
|
340 409 | pub fn key(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::AttributeValue) -> Self {
|
410 + | /* BuilderGenerator.kt:448 */
|
341 411 | let mut hash_map = self.key.unwrap_or_default();
|
342 412 | hash_map.insert(k.into(), v);
|
343 413 | self.key = ::std::option::Option::Some(hash_map);
|
344 414 | self
|
415 + | /* BuilderGenerator.kt:445 */
|
345 416 | }
|
346 - | /// <p>The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.</p>
|
417 + | /// /* BuilderGenerator.kt:312 */<p>The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.</p>
|
347 418 | /// <p>For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</p>
|
419 + | /* BuilderGenerator.kt:314 */
|
348 420 | pub fn set_key(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>) -> Self {
|
421 + | /* BuilderGenerator.kt:315 */
|
349 422 | self.key = input;
|
350 423 | self
|
424 + | /* BuilderGenerator.kt:314 */
|
351 425 | }
|
352 - | /// <p>The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.</p>
|
426 + | /// /* BuilderGenerator.kt:334 */<p>The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.</p>
|
353 427 | /// <p>For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</p>
|
428 + | /* BuilderGenerator.kt:336 */
|
354 429 | pub fn get_key(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>> {
|
430 + | /* BuilderGenerator.kt:337 */
|
355 431 | &self.key
|
432 + | /* BuilderGenerator.kt:336 */
|
356 433 | }
|
357 - | /// Adds a key-value pair to `attribute_updates`.
|
434 + | /// /* BuilderGenerator.kt:436 */Adds a key-value pair to `attribute_updates`.
|
435 + | /* BuilderGenerator.kt:437 */
|
358 436 | ///
|
359 - | /// To override the contents of this collection use [`set_attribute_updates`](Self::set_attribute_updates).
|
437 + | /// /* BuilderGenerator.kt:438 */To override the contents of this collection use [`set_attribute_updates`](Self::set_attribute_updates).
|
438 + | /* BuilderGenerator.kt:439 */
|
360 439 | ///
|
361 - | /// <p>This is a legacy parameter. Use <code>UpdateExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html">AttributeUpdates</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
440 + | /// /* BuilderGenerator.kt:440 */<p>This is a legacy parameter. Use <code>UpdateExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html">AttributeUpdates</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
441 + | /* BuilderGenerator.kt:445 */
|
362 442 | pub fn attribute_updates(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::AttributeValueUpdate) -> Self {
|
443 + | /* BuilderGenerator.kt:448 */
|
363 444 | let mut hash_map = self.attribute_updates.unwrap_or_default();
|
364 445 | hash_map.insert(k.into(), v);
|
365 446 | self.attribute_updates = ::std::option::Option::Some(hash_map);
|
366 447 | self
|
448 + | /* BuilderGenerator.kt:445 */
|
367 449 | }
|
368 - | /// <p>This is a legacy parameter. Use <code>UpdateExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html">AttributeUpdates</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
450 + | /// /* BuilderGenerator.kt:312 */<p>This is a legacy parameter. Use <code>UpdateExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html">AttributeUpdates</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
451 + | /* BuilderGenerator.kt:314 */
|
369 452 | pub fn set_attribute_updates(
|
370 453 | mut self,
|
371 454 | input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValueUpdate>>,
|
372 455 | ) -> Self {
|
456 + | /* BuilderGenerator.kt:315 */
|
373 457 | self.attribute_updates = input;
|
374 458 | self
|
459 + | /* BuilderGenerator.kt:314 */
|
375 460 | }
|
376 - | /// <p>This is a legacy parameter. Use <code>UpdateExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html">AttributeUpdates</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
461 + | /// /* BuilderGenerator.kt:334 */<p>This is a legacy parameter. Use <code>UpdateExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html">AttributeUpdates</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
462 + | /* BuilderGenerator.kt:336 */
|
377 463 | pub fn get_attribute_updates(
|
378 464 | &self,
|
379 465 | ) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValueUpdate>> {
|
466 + | /* BuilderGenerator.kt:337 */
|
380 467 | &self.attribute_updates
|
468 + | /* BuilderGenerator.kt:336 */
|
381 469 | }
|
382 - | /// Adds a key-value pair to `expected`.
|
470 + | /// /* BuilderGenerator.kt:436 */Adds a key-value pair to `expected`.
|
471 + | /* BuilderGenerator.kt:437 */
|
383 472 | ///
|
384 - | /// To override the contents of this collection use [`set_expected`](Self::set_expected).
|
473 + | /// /* BuilderGenerator.kt:438 */To override the contents of this collection use [`set_expected`](Self::set_expected).
|
474 + | /* BuilderGenerator.kt:439 */
|
385 475 | ///
|
386 - | /// <p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html">Expected</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
476 + | /// /* BuilderGenerator.kt:440 */<p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html">Expected</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
477 + | /* BuilderGenerator.kt:445 */
|
387 478 | pub fn expected(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::ExpectedAttributeValue) -> Self {
|
479 + | /* BuilderGenerator.kt:448 */
|
388 480 | let mut hash_map = self.expected.unwrap_or_default();
|
389 481 | hash_map.insert(k.into(), v);
|
390 482 | self.expected = ::std::option::Option::Some(hash_map);
|
391 483 | self
|
484 + | /* BuilderGenerator.kt:445 */
|
392 485 | }
|
393 - | /// <p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html">Expected</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
486 + | /// /* BuilderGenerator.kt:312 */<p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html">Expected</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
487 + | /* BuilderGenerator.kt:314 */
|
394 488 | pub fn set_expected(
|
395 489 | mut self,
|
396 490 | input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::ExpectedAttributeValue>>,
|
397 491 | ) -> Self {
|
492 + | /* BuilderGenerator.kt:315 */
|
398 493 | self.expected = input;
|
399 494 | self
|
495 + | /* BuilderGenerator.kt:314 */
|
400 496 | }
|
401 - | /// <p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html">Expected</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
497 + | /// /* BuilderGenerator.kt:334 */<p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html">Expected</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
498 + | /* BuilderGenerator.kt:336 */
|
402 499 | pub fn get_expected(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::ExpectedAttributeValue>> {
|
500 + | /* BuilderGenerator.kt:337 */
|
403 501 | &self.expected
|
502 + | /* BuilderGenerator.kt:336 */
|
404 503 | }
|
405 - | /// <p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html">ConditionalOperator</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
504 + | /// /* BuilderGenerator.kt:286 */<p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html">ConditionalOperator</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
505 + | /* BuilderGenerator.kt:291 */
|
406 506 | pub fn conditional_operator(mut self, input: crate::types::ConditionalOperator) -> Self {
|
507 + | /* BuilderGenerator.kt:292 */
|
407 508 | self.conditional_operator = ::std::option::Option::Some(input);
|
509 + | /* BuilderGenerator.kt:293 */
|
408 510 | self
|
511 + | /* BuilderGenerator.kt:291 */
|
409 512 | }
|
410 - | /// <p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html">ConditionalOperator</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
513 + | /// /* BuilderGenerator.kt:312 */<p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html">ConditionalOperator</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
514 + | /* BuilderGenerator.kt:314 */
|
411 515 | pub fn set_conditional_operator(mut self, input: ::std::option::Option<crate::types::ConditionalOperator>) -> Self {
|
516 + | /* BuilderGenerator.kt:315 */
|
412 517 | self.conditional_operator = input;
|
413 518 | self
|
519 + | /* BuilderGenerator.kt:314 */
|
414 520 | }
|
415 - | /// <p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html">ConditionalOperator</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
521 + | /// /* BuilderGenerator.kt:334 */<p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html">ConditionalOperator</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
522 + | /* BuilderGenerator.kt:336 */
|
416 523 | pub fn get_conditional_operator(&self) -> &::std::option::Option<crate::types::ConditionalOperator> {
|
524 + | /* BuilderGenerator.kt:337 */
|
417 525 | &self.conditional_operator
|
526 + | /* BuilderGenerator.kt:336 */
|
418 527 | }
|
419 - | /// <p>Use <code>ReturnValues</code> if you want to get the item attributes as they appear before or after they are updated. For <code>UpdateItem</code>, the valid values are:</p>
|
528 + | /// /* BuilderGenerator.kt:286 */<p>Use <code>ReturnValues</code> if you want to get the item attributes as they appear before or after they are updated. For <code>UpdateItem</code>, the valid values are:</p>
|
420 529 | /// <ul>
|
421 530 | /// <li>
|
422 531 | /// <p><code>NONE</code> - If <code>ReturnValues</code> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <code>ReturnValues</code>.)</p></li>
|
423 532 | /// <li>
|
424 533 | /// <p><code>ALL_OLD</code> - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.</p></li>
|
425 534 | /// <li>
|
426 535 | /// <p><code>UPDATED_OLD</code> - Returns only the updated attributes, as they appeared before the UpdateItem operation.</p></li>
|
427 536 | /// <li>
|
428 537 | /// <p><code>ALL_NEW</code> - Returns all of the attributes of the item, as they appear after the UpdateItem operation.</p></li>
|
429 538 | /// <li>
|
430 539 | /// <p><code>UPDATED_NEW</code> - Returns only the updated attributes, as they appear after the UpdateItem operation.</p></li>
|
431 540 | /// </ul>
|
432 541 | /// <p>There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.</p>
|
433 542 | /// <p>The values returned are strongly consistent.</p>
|
543 + | /* BuilderGenerator.kt:291 */
|
434 544 | pub fn return_values(mut self, input: crate::types::ReturnValue) -> Self {
|
545 + | /* BuilderGenerator.kt:292 */
|
435 546 | self.return_values = ::std::option::Option::Some(input);
|
547 + | /* BuilderGenerator.kt:293 */
|
436 548 | self
|
549 + | /* BuilderGenerator.kt:291 */
|
437 550 | }
|
438 - | /// <p>Use <code>ReturnValues</code> if you want to get the item attributes as they appear before or after they are updated. For <code>UpdateItem</code>, the valid values are:</p>
|
551 + | /// /* BuilderGenerator.kt:312 */<p>Use <code>ReturnValues</code> if you want to get the item attributes as they appear before or after they are updated. For <code>UpdateItem</code>, the valid values are:</p>
|
439 552 | /// <ul>
|
440 553 | /// <li>
|
441 554 | /// <p><code>NONE</code> - If <code>ReturnValues</code> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <code>ReturnValues</code>.)</p></li>
|
442 555 | /// <li>
|
443 556 | /// <p><code>ALL_OLD</code> - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.</p></li>
|
444 557 | /// <li>
|
445 558 | /// <p><code>UPDATED_OLD</code> - Returns only the updated attributes, as they appeared before the UpdateItem operation.</p></li>
|
446 559 | /// <li>
|
447 560 | /// <p><code>ALL_NEW</code> - Returns all of the attributes of the item, as they appear after the UpdateItem operation.</p></li>
|
448 561 | /// <li>
|
449 562 | /// <p><code>UPDATED_NEW</code> - Returns only the updated attributes, as they appear after the UpdateItem operation.</p></li>
|
450 563 | /// </ul>
|
451 564 | /// <p>There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.</p>
|
452 565 | /// <p>The values returned are strongly consistent.</p>
|
566 + | /* BuilderGenerator.kt:314 */
|
453 567 | pub fn set_return_values(mut self, input: ::std::option::Option<crate::types::ReturnValue>) -> Self {
|
568 + | /* BuilderGenerator.kt:315 */
|
454 569 | self.return_values = input;
|
455 570 | self
|
571 + | /* BuilderGenerator.kt:314 */
|
456 572 | }
|
457 - | /// <p>Use <code>ReturnValues</code> if you want to get the item attributes as they appear before or after they are updated. For <code>UpdateItem</code>, the valid values are:</p>
|
573 + | /// /* BuilderGenerator.kt:334 */<p>Use <code>ReturnValues</code> if you want to get the item attributes as they appear before or after they are updated. For <code>UpdateItem</code>, the valid values are:</p>
|
458 574 | /// <ul>
|
459 575 | /// <li>
|
460 576 | /// <p><code>NONE</code> - If <code>ReturnValues</code> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <code>ReturnValues</code>.)</p></li>
|
461 577 | /// <li>
|
462 578 | /// <p><code>ALL_OLD</code> - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.</p></li>
|
463 579 | /// <li>
|
464 580 | /// <p><code>UPDATED_OLD</code> - Returns only the updated attributes, as they appeared before the UpdateItem operation.</p></li>
|
465 581 | /// <li>
|
466 582 | /// <p><code>ALL_NEW</code> - Returns all of the attributes of the item, as they appear after the UpdateItem operation.</p></li>
|
467 583 | /// <li>
|
468 584 | /// <p><code>UPDATED_NEW</code> - Returns only the updated attributes, as they appear after the UpdateItem operation.</p></li>
|
469 585 | /// </ul>
|
470 586 | /// <p>There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.</p>
|
471 587 | /// <p>The values returned are strongly consistent.</p>
|
588 + | /* BuilderGenerator.kt:336 */
|
472 589 | pub fn get_return_values(&self) -> &::std::option::Option<crate::types::ReturnValue> {
|
590 + | /* BuilderGenerator.kt:337 */
|
473 591 | &self.return_values
|
592 + | /* BuilderGenerator.kt:336 */
|
474 593 | }
|
475 - | /// <p>Determines the level of detail about provisioned throughput consumption that is returned in the response:</p>
|
594 + | /// /* BuilderGenerator.kt:286 */<p>Determines the level of detail about provisioned throughput consumption that is returned in the response:</p>
|
476 595 | /// <ul>
|
477 596 | /// <li>
|
478 597 | /// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
|
479 598 | /// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
|
480 599 | /// <li>
|
481 600 | /// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
|
482 601 | /// <li>
|
483 602 | /// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
|
484 603 | /// </ul>
|
604 + | /* BuilderGenerator.kt:291 */
|
485 605 | pub fn return_consumed_capacity(mut self, input: crate::types::ReturnConsumedCapacity) -> Self {
|
606 + | /* BuilderGenerator.kt:292 */
|
486 607 | self.return_consumed_capacity = ::std::option::Option::Some(input);
|
608 + | /* BuilderGenerator.kt:293 */
|
487 609 | self
|
610 + | /* BuilderGenerator.kt:291 */
|
488 611 | }
|
489 - | /// <p>Determines the level of detail about provisioned throughput consumption that is returned in the response:</p>
|
612 + | /// /* BuilderGenerator.kt:312 */<p>Determines the level of detail about provisioned throughput consumption that is returned in the response:</p>
|
490 613 | /// <ul>
|
491 614 | /// <li>
|
492 615 | /// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
|
493 616 | /// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
|
494 617 | /// <li>
|
495 618 | /// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
|
496 619 | /// <li>
|
497 620 | /// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
|
498 621 | /// </ul>
|
622 + | /* BuilderGenerator.kt:314 */
|
499 623 | pub fn set_return_consumed_capacity(mut self, input: ::std::option::Option<crate::types::ReturnConsumedCapacity>) -> Self {
|
624 + | /* BuilderGenerator.kt:315 */
|
500 625 | self.return_consumed_capacity = input;
|
501 626 | self
|
627 + | /* BuilderGenerator.kt:314 */
|
502 628 | }
|
503 - | /// <p>Determines the level of detail about provisioned throughput consumption that is returned in the response:</p>
|
629 + | /// /* BuilderGenerator.kt:334 */<p>Determines the level of detail about provisioned throughput consumption that is returned in the response:</p>
|
504 630 | /// <ul>
|
505 631 | /// <li>
|
506 632 | /// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
|
507 633 | /// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
|
508 634 | /// <li>
|
509 635 | /// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
|
510 636 | /// <li>
|
511 637 | /// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
|
512 638 | /// </ul>
|
639 + | /* BuilderGenerator.kt:336 */
|
513 640 | pub fn get_return_consumed_capacity(&self) -> &::std::option::Option<crate::types::ReturnConsumedCapacity> {
|
641 + | /* BuilderGenerator.kt:337 */
|
514 642 | &self.return_consumed_capacity
|
643 + | /* BuilderGenerator.kt:336 */
|
515 644 | }
|
516 - | /// <p>Determines whether item collection metrics are returned. If set to <code>SIZE</code>, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <code>NONE</code> (the default), no statistics are returned.</p>
|
645 + | /// /* BuilderGenerator.kt:286 */<p>Determines whether item collection metrics are returned. If set to <code>SIZE</code>, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <code>NONE</code> (the default), no statistics are returned.</p>
|
646 + | /* BuilderGenerator.kt:291 */
|
517 647 | pub fn return_item_collection_metrics(mut self, input: crate::types::ReturnItemCollectionMetrics) -> Self {
|
648 + | /* BuilderGenerator.kt:292 */
|
518 649 | self.return_item_collection_metrics = ::std::option::Option::Some(input);
|
650 + | /* BuilderGenerator.kt:293 */
|
519 651 | self
|
652 + | /* BuilderGenerator.kt:291 */
|
520 653 | }
|
521 - | /// <p>Determines whether item collection metrics are returned. If set to <code>SIZE</code>, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <code>NONE</code> (the default), no statistics are returned.</p>
|
654 + | /// /* BuilderGenerator.kt:312 */<p>Determines whether item collection metrics are returned. If set to <code>SIZE</code>, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <code>NONE</code> (the default), no statistics are returned.</p>
|
655 + | /* BuilderGenerator.kt:314 */
|
522 656 | pub fn set_return_item_collection_metrics(mut self, input: ::std::option::Option<crate::types::ReturnItemCollectionMetrics>) -> Self {
|
657 + | /* BuilderGenerator.kt:315 */
|
523 658 | self.return_item_collection_metrics = input;
|
524 659 | self
|
660 + | /* BuilderGenerator.kt:314 */
|
525 661 | }
|
526 - | /// <p>Determines whether item collection metrics are returned. If set to <code>SIZE</code>, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <code>NONE</code> (the default), no statistics are returned.</p>
|
662 + | /// /* BuilderGenerator.kt:334 */<p>Determines whether item collection metrics are returned. If set to <code>SIZE</code>, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <code>NONE</code> (the default), no statistics are returned.</p>
|
663 + | /* BuilderGenerator.kt:336 */
|
527 664 | pub fn get_return_item_collection_metrics(&self) -> &::std::option::Option<crate::types::ReturnItemCollectionMetrics> {
|
665 + | /* BuilderGenerator.kt:337 */
|
528 666 | &self.return_item_collection_metrics
|
667 + | /* BuilderGenerator.kt:336 */
|
529 668 | }
|
530 - | /// <p>An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.</p>
|
669 + | /// /* BuilderGenerator.kt:286 */<p>An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.</p>
|
531 670 | /// <p>The following action values are available for <code>UpdateExpression</code>.</p>
|
532 671 | /// <ul>
|
533 672 | /// <li>
|
534 673 | /// <p><code>SET</code> - Adds one or more attributes and values to an item. If any of these attributes already exist, they are replaced by the new values. You can also use <code>SET</code> to add or subtract from an attribute that is of type Number. For example: <code>SET myNum = myNum + :val</code></p>
|
535 674 | /// <p><code>SET</code> supports the following functions:</p>
|
536 675 | /// <ul>
|
537 676 | /// <li>
|
538 677 | /// <p><code>if_not_exists (path, operand)</code> - if the item does not contain an attribute at the specified path, then <code>if_not_exists</code> evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.</p></li>
|
539 678 | /// <li>
|
540 679 | /// <p><code>list_append (operand, operand)</code> - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.</p></li>
|
541 680 | /// </ul>
|
542 681 | /// <p>These function names are case-sensitive.</p></li>
|
543 682 | /// <li>
|
544 683 | /// <p><code>REMOVE</code> - Removes one or more attributes from an item.</p></li>
|
545 684 | /// <li>
|
546 685 | /// <p><code>ADD</code> - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of <code>ADD</code> depends on the data type of the attribute:</p>
|
547 686 | /// <ul>
|
548 687 | /// <li>
|
549 688 | /// <p>If the existing attribute is a number, and if <code>Value</code> is also a number, then <code>Value</code> is mathematically added to the existing attribute. If <code>Value</code> is a negative number, then it is subtracted from the existing attribute.</p><note>
|
550 689 | /// <p>If you use <code>ADD</code> to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value.</p>
|
551 690 | /// <p>Similarly, if you use <code>ADD</code> for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value. For example, suppose that the item you want to update doesn't have an attribute named <code>itemcount</code>, but you decide to <code>ADD</code> the number <code>3</code> to this attribute anyway. DynamoDB will create the <code>itemcount</code> attribute, set its initial value to <code>0</code>, and finally add <code>3</code> to it. The result will be a new <code>itemcount</code> attribute in the item, with a value of <code>3</code>.</p>
|
552 691 | /// </note></li>
|
553 692 | /// <li>
|
554 693 | /// <p>If the existing data type is a set and if <code>Value</code> is also a set, then <code>Value</code> is added to the existing set. For example, if the attribute value is the set <code>\[1,2\]</code>, and the <code>ADD</code> action specified <code>\[3\]</code>, then the final attribute value is <code>\[1,2,3\]</code>. An error occurs if an <code>ADD</code> action is specified for a set attribute and the attribute type specified does not match the existing set type.</p>
|
555 694 | /// <p>Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the <code>Value</code> must also be a set of strings.</p></li>
|
556 695 | /// </ul><important>
|
557 696 | /// <p>The <code>ADD</code> action only supports Number and set data types. In addition, <code>ADD</code> can only be used on top-level attributes, not nested attributes.</p>
|
558 697 | /// </important></li>
|
559 698 | /// <li>
|
560 699 | /// <p><code>DELETE</code> - Deletes an element from a set.</p>
|
561 700 | /// <p>If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set <code>\[a,b,c\]</code> and the <code>DELETE</code> action specifies <code>\[a,c\]</code>, then the final attribute value is <code>\[b\]</code>. Specifying an empty set is an error.</p><important>
|
562 701 | /// <p>The <code>DELETE</code> action only supports set data types. In addition, <code>DELETE</code> can only be used on top-level attributes, not nested attributes.</p>
|
563 702 | /// </important></li>
|
564 703 | /// </ul>
|
565 704 | /// <p>You can have many actions in a single expression, such as the following: <code>SET a=:value1, b=:value2 DELETE :value3, :value4, :value5</code></p>
|
566 705 | /// <p>For more information on update expressions, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Modifying.html">Modifying Items and Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
706 + | /* BuilderGenerator.kt:291 */
|
567 707 | pub fn update_expression(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
|
708 + | /* BuilderGenerator.kt:292 */
|
568 709 | self.update_expression = ::std::option::Option::Some(input.into());
|
710 + | /* BuilderGenerator.kt:293 */
|
569 711 | self
|
712 + | /* BuilderGenerator.kt:291 */
|
570 713 | }
|
571 - | /// <p>An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.</p>
|
714 + | /// /* BuilderGenerator.kt:312 */<p>An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.</p>
|
572 715 | /// <p>The following action values are available for <code>UpdateExpression</code>.</p>
|
573 716 | /// <ul>
|
574 717 | /// <li>
|
575 718 | /// <p><code>SET</code> - Adds one or more attributes and values to an item. If any of these attributes already exist, they are replaced by the new values. You can also use <code>SET</code> to add or subtract from an attribute that is of type Number. For example: <code>SET myNum = myNum + :val</code></p>
|
576 719 | /// <p><code>SET</code> supports the following functions:</p>
|
577 720 | /// <ul>
|
578 721 | /// <li>
|
579 722 | /// <p><code>if_not_exists (path, operand)</code> - if the item does not contain an attribute at the specified path, then <code>if_not_exists</code> evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.</p></li>
|
580 723 | /// <li>
|
581 724 | /// <p><code>list_append (operand, operand)</code> - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.</p></li>
|
582 725 | /// </ul>
|
583 726 | /// <p>These function names are case-sensitive.</p></li>
|
584 727 | /// <li>
|
585 728 | /// <p><code>REMOVE</code> - Removes one or more attributes from an item.</p></li>
|
586 729 | /// <li>
|
587 730 | /// <p><code>ADD</code> - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of <code>ADD</code> depends on the data type of the attribute:</p>
|
588 731 | /// <ul>
|
589 732 | /// <li>
|
590 733 | /// <p>If the existing attribute is a number, and if <code>Value</code> is also a number, then <code>Value</code> is mathematically added to the existing attribute. If <code>Value</code> is a negative number, then it is subtracted from the existing attribute.</p><note>
|
591 734 | /// <p>If you use <code>ADD</code> to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value.</p>
|
592 735 | /// <p>Similarly, if you use <code>ADD</code> for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value. For example, suppose that the item you want to update doesn't have an attribute named <code>itemcount</code>, but you decide to <code>ADD</code> the number <code>3</code> to this attribute anyway. DynamoDB will create the <code>itemcount</code> attribute, set its initial value to <code>0</code>, and finally add <code>3</code> to it. The result will be a new <code>itemcount</code> attribute in the item, with a value of <code>3</code>.</p>
|
593 736 | /// </note></li>
|
594 737 | /// <li>
|
595 738 | /// <p>If the existing data type is a set and if <code>Value</code> is also a set, then <code>Value</code> is added to the existing set. For example, if the attribute value is the set <code>\[1,2\]</code>, and the <code>ADD</code> action specified <code>\[3\]</code>, then the final attribute value is <code>\[1,2,3\]</code>. An error occurs if an <code>ADD</code> action is specified for a set attribute and the attribute type specified does not match the existing set type.</p>
|
596 739 | /// <p>Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the <code>Value</code> must also be a set of strings.</p></li>
|
597 740 | /// </ul><important>
|
598 741 | /// <p>The <code>ADD</code> action only supports Number and set data types. In addition, <code>ADD</code> can only be used on top-level attributes, not nested attributes.</p>
|
599 742 | /// </important></li>
|
600 743 | /// <li>
|
601 744 | /// <p><code>DELETE</code> - Deletes an element from a set.</p>
|
602 745 | /// <p>If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set <code>\[a,b,c\]</code> and the <code>DELETE</code> action specifies <code>\[a,c\]</code>, then the final attribute value is <code>\[b\]</code>. Specifying an empty set is an error.</p><important>
|
603 746 | /// <p>The <code>DELETE</code> action only supports set data types. In addition, <code>DELETE</code> can only be used on top-level attributes, not nested attributes.</p>
|
604 747 | /// </important></li>
|
605 748 | /// </ul>
|
606 749 | /// <p>You can have many actions in a single expression, such as the following: <code>SET a=:value1, b=:value2 DELETE :value3, :value4, :value5</code></p>
|
607 750 | /// <p>For more information on update expressions, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Modifying.html">Modifying Items and Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
751 + | /* BuilderGenerator.kt:314 */
|
608 752 | pub fn set_update_expression(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
|
753 + | /* BuilderGenerator.kt:315 */
|
609 754 | self.update_expression = input;
|
610 755 | self
|
756 + | /* BuilderGenerator.kt:314 */
|
611 757 | }
|
612 - | /// <p>An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.</p>
|
758 + | /// /* BuilderGenerator.kt:334 */<p>An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.</p>
|
613 759 | /// <p>The following action values are available for <code>UpdateExpression</code>.</p>
|
614 760 | /// <ul>
|
615 761 | /// <li>
|
616 762 | /// <p><code>SET</code> - Adds one or more attributes and values to an item. If any of these attributes already exist, they are replaced by the new values. You can also use <code>SET</code> to add or subtract from an attribute that is of type Number. For example: <code>SET myNum = myNum + :val</code></p>
|
617 763 | /// <p><code>SET</code> supports the following functions:</p>
|
618 764 | /// <ul>
|
619 765 | /// <li>
|
620 766 | /// <p><code>if_not_exists (path, operand)</code> - if the item does not contain an attribute at the specified path, then <code>if_not_exists</code> evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.</p></li>
|
621 767 | /// <li>
|
622 768 | /// <p><code>list_append (operand, operand)</code> - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.</p></li>
|
623 769 | /// </ul>
|
624 770 | /// <p>These function names are case-sensitive.</p></li>
|
625 771 | /// <li>
|
626 772 | /// <p><code>REMOVE</code> - Removes one or more attributes from an item.</p></li>
|
627 773 | /// <li>
|
628 774 | /// <p><code>ADD</code> - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of <code>ADD</code> depends on the data type of the attribute:</p>
|
629 775 | /// <ul>
|
630 776 | /// <li>
|
631 777 | /// <p>If the existing attribute is a number, and if <code>Value</code> is also a number, then <code>Value</code> is mathematically added to the existing attribute. If <code>Value</code> is a negative number, then it is subtracted from the existing attribute.</p><note>
|
632 778 | /// <p>If you use <code>ADD</code> to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value.</p>
|
633 779 | /// <p>Similarly, if you use <code>ADD</code> for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value. For example, suppose that the item you want to update doesn't have an attribute named <code>itemcount</code>, but you decide to <code>ADD</code> the number <code>3</code> to this attribute anyway. DynamoDB will create the <code>itemcount</code> attribute, set its initial value to <code>0</code>, and finally add <code>3</code> to it. The result will be a new <code>itemcount</code> attribute in the item, with a value of <code>3</code>.</p>
|
634 780 | /// </note></li>
|
635 781 | /// <li>
|
636 782 | /// <p>If the existing data type is a set and if <code>Value</code> is also a set, then <code>Value</code> is added to the existing set. For example, if the attribute value is the set <code>\[1,2\]</code>, and the <code>ADD</code> action specified <code>\[3\]</code>, then the final attribute value is <code>\[1,2,3\]</code>. An error occurs if an <code>ADD</code> action is specified for a set attribute and the attribute type specified does not match the existing set type.</p>
|
637 783 | /// <p>Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the <code>Value</code> must also be a set of strings.</p></li>
|
638 784 | /// </ul><important>
|
639 785 | /// <p>The <code>ADD</code> action only supports Number and set data types. In addition, <code>ADD</code> can only be used on top-level attributes, not nested attributes.</p>
|
640 786 | /// </important></li>
|
641 787 | /// <li>
|
642 788 | /// <p><code>DELETE</code> - Deletes an element from a set.</p>
|
643 789 | /// <p>If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set <code>\[a,b,c\]</code> and the <code>DELETE</code> action specifies <code>\[a,c\]</code>, then the final attribute value is <code>\[b\]</code>. Specifying an empty set is an error.</p><important>
|
644 790 | /// <p>The <code>DELETE</code> action only supports set data types. In addition, <code>DELETE</code> can only be used on top-level attributes, not nested attributes.</p>
|
645 791 | /// </important></li>
|
646 792 | /// </ul>
|
647 793 | /// <p>You can have many actions in a single expression, such as the following: <code>SET a=:value1, b=:value2 DELETE :value3, :value4, :value5</code></p>
|
648 794 | /// <p>For more information on update expressions, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Modifying.html">Modifying Items and Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
795 + | /* BuilderGenerator.kt:336 */
|
649 796 | pub fn get_update_expression(&self) -> &::std::option::Option<::std::string::String> {
|
797 + | /* BuilderGenerator.kt:337 */
|
650 798 | &self.update_expression
|
799 + | /* BuilderGenerator.kt:336 */
|
651 800 | }
|
652 - | /// <p>A condition that must be satisfied in order for a conditional update to succeed.</p>
|
801 + | /// /* BuilderGenerator.kt:286 */<p>A condition that must be satisfied in order for a conditional update to succeed.</p>
|
653 802 | /// <p>An expression can contain any of the following:</p>
|
654 803 | /// <ul>
|
655 804 | /// <li>
|
656 805 | /// <p>Functions: <code>attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size</code></p>
|
657 806 | /// <p>These function names are case-sensitive.</p></li>
|
658 807 | /// <li>
|
659 808 | /// <p>Comparison operators: <code>= | <> | < | > | <= | >= | BETWEEN | IN </code></p></li>
|
660 809 | /// <li>
|
661 810 | /// <p>Logical operators: <code>AND | OR | NOT</code></p></li>
|
662 811 | /// </ul>
|
663 812 | /// <p>For more information about condition expressions, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Specifying Conditions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
813 + | /* BuilderGenerator.kt:291 */
|
664 814 | pub fn condition_expression(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
|
815 + | /* BuilderGenerator.kt:292 */
|
665 816 | self.condition_expression = ::std::option::Option::Some(input.into());
|
817 + | /* BuilderGenerator.kt:293 */
|
666 818 | self
|
819 + | /* BuilderGenerator.kt:291 */
|
667 820 | }
|
668 - | /// <p>A condition that must be satisfied in order for a conditional update to succeed.</p>
|
821 + | /// /* BuilderGenerator.kt:312 */<p>A condition that must be satisfied in order for a conditional update to succeed.</p>
|
669 822 | /// <p>An expression can contain any of the following:</p>
|
670 823 | /// <ul>
|
671 824 | /// <li>
|
672 825 | /// <p>Functions: <code>attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size</code></p>
|
673 826 | /// <p>These function names are case-sensitive.</p></li>
|
674 827 | /// <li>
|
675 828 | /// <p>Comparison operators: <code>= | <> | < | > | <= | >= | BETWEEN | IN </code></p></li>
|
676 829 | /// <li>
|
677 830 | /// <p>Logical operators: <code>AND | OR | NOT</code></p></li>
|
678 831 | /// </ul>
|
679 832 | /// <p>For more information about condition expressions, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Specifying Conditions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
833 + | /* BuilderGenerator.kt:314 */
|
680 834 | pub fn set_condition_expression(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
|
835 + | /* BuilderGenerator.kt:315 */
|
681 836 | self.condition_expression = input;
|
682 837 | self
|
838 + | /* BuilderGenerator.kt:314 */
|
683 839 | }
|
684 - | /// <p>A condition that must be satisfied in order for a conditional update to succeed.</p>
|
840 + | /// /* BuilderGenerator.kt:334 */<p>A condition that must be satisfied in order for a conditional update to succeed.</p>
|
685 841 | /// <p>An expression can contain any of the following:</p>
|
686 842 | /// <ul>
|
687 843 | /// <li>
|
688 844 | /// <p>Functions: <code>attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size</code></p>
|
689 845 | /// <p>These function names are case-sensitive.</p></li>
|
690 846 | /// <li>
|
691 847 | /// <p>Comparison operators: <code>= | <> | < | > | <= | >= | BETWEEN | IN </code></p></li>
|
692 848 | /// <li>
|
693 849 | /// <p>Logical operators: <code>AND | OR | NOT</code></p></li>
|
694 850 | /// </ul>
|
695 851 | /// <p>For more information about condition expressions, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Specifying Conditions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
852 + | /* BuilderGenerator.kt:336 */
|
696 853 | pub fn get_condition_expression(&self) -> &::std::option::Option<::std::string::String> {
|
854 + | /* BuilderGenerator.kt:337 */
|
697 855 | &self.condition_expression
|
856 + | /* BuilderGenerator.kt:336 */
|
698 857 | }
|
699 - | /// Adds a key-value pair to `expression_attribute_names`.
|
858 + | /// /* BuilderGenerator.kt:436 */Adds a key-value pair to `expression_attribute_names`.
|
859 + | /* BuilderGenerator.kt:437 */
|
700 860 | ///
|
701 - | /// To override the contents of this collection use [`set_expression_attribute_names`](Self::set_expression_attribute_names).
|
861 + | /// /* BuilderGenerator.kt:438 */To override the contents of this collection use [`set_expression_attribute_names`](Self::set_expression_attribute_names).
|
862 + | /* BuilderGenerator.kt:439 */
|
702 863 | ///
|
703 - | /// <p>One or more substitution tokens for attribute names in an expression. The following are some use cases for using <code>ExpressionAttributeNames</code>:</p>
|
864 + | /// /* BuilderGenerator.kt:440 */<p>One or more substitution tokens for attribute names in an expression. The following are some use cases for using <code>ExpressionAttributeNames</code>:</p>
|
704 865 | /// <ul>
|
705 866 | /// <li>
|
706 867 | /// <p>To access an attribute whose name conflicts with a DynamoDB reserved word.</p></li>
|
707 868 | /// <li>
|
708 869 | /// <p>To create a placeholder for repeating occurrences of an attribute name in an expression.</p></li>
|
709 870 | /// <li>
|
710 871 | /// <p>To prevent special characters in an attribute name from being misinterpreted in an expression.</p></li>
|
711 872 | /// </ul>
|
712 873 | /// <p>Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name:</p>
|
713 874 | /// <ul>
|
714 875 | /// <li>
|
715 876 | /// <p><code>Percentile</code></p></li>
|
716 877 | /// </ul>
|
717 878 | /// <p>The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>.) To work around this, you could specify the following for <code>ExpressionAttributeNames</code>:</p>
|
718 879 | /// <ul>
|
719 880 | /// <li>
|
720 881 | /// <p><code>{"#P":"Percentile"}</code></p></li>
|
721 882 | /// </ul>
|
722 883 | /// <p>You could then use this substitution in an expression, as in this example:</p>
|
723 884 | /// <ul>
|
724 885 | /// <li>
|
725 886 | /// <p><code>#P = :val</code></p></li>
|
726 887 | /// </ul><note>
|
727 888 | /// <p>Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime.</p>
|
728 889 | /// </note>
|
729 890 | /// <p>For more information about expression attribute names, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
891 + | /* BuilderGenerator.kt:445 */
|
730 892 | pub fn expression_attribute_names(
|
731 893 | mut self,
|
732 894 | k: impl ::std::convert::Into<::std::string::String>,
|
733 895 | v: impl ::std::convert::Into<::std::string::String>,
|
734 896 | ) -> Self {
|
897 + | /* BuilderGenerator.kt:448 */
|
735 898 | let mut hash_map = self.expression_attribute_names.unwrap_or_default();
|
736 899 | hash_map.insert(k.into(), v.into());
|
737 900 | self.expression_attribute_names = ::std::option::Option::Some(hash_map);
|
738 901 | self
|
902 + | /* BuilderGenerator.kt:445 */
|
739 903 | }
|
740 - | /// <p>One or more substitution tokens for attribute names in an expression. The following are some use cases for using <code>ExpressionAttributeNames</code>:</p>
|
904 + | /// /* BuilderGenerator.kt:312 */<p>One or more substitution tokens for attribute names in an expression. The following are some use cases for using <code>ExpressionAttributeNames</code>:</p>
|
741 905 | /// <ul>
|
742 906 | /// <li>
|
743 907 | /// <p>To access an attribute whose name conflicts with a DynamoDB reserved word.</p></li>
|
744 908 | /// <li>
|
745 909 | /// <p>To create a placeholder for repeating occurrences of an attribute name in an expression.</p></li>
|
746 910 | /// <li>
|
747 911 | /// <p>To prevent special characters in an attribute name from being misinterpreted in an expression.</p></li>
|
748 912 | /// </ul>
|
749 913 | /// <p>Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name:</p>
|
750 914 | /// <ul>
|
751 915 | /// <li>
|
752 916 | /// <p><code>Percentile</code></p></li>
|
753 917 | /// </ul>
|
754 918 | /// <p>The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>.) To work around this, you could specify the following for <code>ExpressionAttributeNames</code>:</p>
|
755 919 | /// <ul>
|
756 920 | /// <li>
|
757 921 | /// <p><code>{"#P":"Percentile"}</code></p></li>
|
758 922 | /// </ul>
|
759 923 | /// <p>You could then use this substitution in an expression, as in this example:</p>
|
760 924 | /// <ul>
|
761 925 | /// <li>
|
762 926 | /// <p><code>#P = :val</code></p></li>
|
763 927 | /// </ul><note>
|
764 928 | /// <p>Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime.</p>
|
765 929 | /// </note>
|
766 930 | /// <p>For more information about expression attribute names, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
931 + | /* BuilderGenerator.kt:314 */
|
767 932 | pub fn set_expression_attribute_names(
|
768 933 | mut self,
|
769 934 | input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
|
770 935 | ) -> Self {
|
936 + | /* BuilderGenerator.kt:315 */
|
771 937 | self.expression_attribute_names = input;
|
772 938 | self
|
939 + | /* BuilderGenerator.kt:314 */
|
773 940 | }
|
774 - | /// <p>One or more substitution tokens for attribute names in an expression. The following are some use cases for using <code>ExpressionAttributeNames</code>:</p>
|
941 + | /// /* BuilderGenerator.kt:334 */<p>One or more substitution tokens for attribute names in an expression. The following are some use cases for using <code>ExpressionAttributeNames</code>:</p>
|
775 942 | /// <ul>
|
776 943 | /// <li>
|
777 944 | /// <p>To access an attribute whose name conflicts with a DynamoDB reserved word.</p></li>
|
778 945 | /// <li>
|
779 946 | /// <p>To create a placeholder for repeating occurrences of an attribute name in an expression.</p></li>
|
780 947 | /// <li>
|
781 948 | /// <p>To prevent special characters in an attribute name from being misinterpreted in an expression.</p></li>
|
782 949 | /// </ul>
|
783 950 | /// <p>Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name:</p>
|
784 951 | /// <ul>
|
785 952 | /// <li>
|
786 953 | /// <p><code>Percentile</code></p></li>
|
787 954 | /// </ul>
|
788 955 | /// <p>The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>.) To work around this, you could specify the following for <code>ExpressionAttributeNames</code>:</p>
|
789 956 | /// <ul>
|
790 957 | /// <li>
|
791 958 | /// <p><code>{"#P":"Percentile"}</code></p></li>
|
792 959 | /// </ul>
|
793 960 | /// <p>You could then use this substitution in an expression, as in this example:</p>
|
794 961 | /// <ul>
|
795 962 | /// <li>
|
796 963 | /// <p><code>#P = :val</code></p></li>
|
797 964 | /// </ul><note>
|
798 965 | /// <p>Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime.</p>
|
799 966 | /// </note>
|
800 967 | /// <p>For more information about expression attribute names, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Specifying Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
968 + | /* BuilderGenerator.kt:336 */
|
801 969 | pub fn get_expression_attribute_names(
|
802 970 | &self,
|
803 971 | ) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
|
972 + | /* BuilderGenerator.kt:337 */
|
804 973 | &self.expression_attribute_names
|
974 + | /* BuilderGenerator.kt:336 */
|
805 975 | }
|
806 - | /// Adds a key-value pair to `expression_attribute_values`.
|
976 + | /// /* BuilderGenerator.kt:436 */Adds a key-value pair to `expression_attribute_values`.
|
977 + | /* BuilderGenerator.kt:437 */
|
807 978 | ///
|
808 - | /// To override the contents of this collection use [`set_expression_attribute_values`](Self::set_expression_attribute_values).
|
979 + | /// /* BuilderGenerator.kt:438 */To override the contents of this collection use [`set_expression_attribute_values`](Self::set_expression_attribute_values).
|
980 + | /* BuilderGenerator.kt:439 */
|
809 981 | ///
|
810 - | /// <p>One or more values that can be substituted in an expression.</p>
|
982 + | /// /* BuilderGenerator.kt:440 */<p>One or more values that can be substituted in an expression.</p>
|
811 983 | /// <p>Use the <b>:</b> (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the <code>ProductStatus</code> attribute was one of the following:</p>
|
812 984 | /// <p><code>Available | Backordered | Discontinued</code></p>
|
813 985 | /// <p>You would first need to specify <code>ExpressionAttributeValues</code> as follows:</p>
|
814 986 | /// <p><code>{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }</code></p>
|
815 987 | /// <p>You could then use these values in an expression, such as this:</p>
|
816 988 | /// <p><code>ProductStatus IN (:avail, :back, :disc)</code></p>
|
817 989 | /// <p>For more information on expression attribute values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Condition Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
990 + | /* BuilderGenerator.kt:445 */
|
818 991 | pub fn expression_attribute_values(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::AttributeValue) -> Self {
|
992 + | /* BuilderGenerator.kt:448 */
|
819 993 | let mut hash_map = self.expression_attribute_values.unwrap_or_default();
|
820 994 | hash_map.insert(k.into(), v);
|
821 995 | self.expression_attribute_values = ::std::option::Option::Some(hash_map);
|
822 996 | self
|
997 + | /* BuilderGenerator.kt:445 */
|
823 998 | }
|
824 - | /// <p>One or more values that can be substituted in an expression.</p>
|
999 + | /// /* BuilderGenerator.kt:312 */<p>One or more values that can be substituted in an expression.</p>
|
825 1000 | /// <p>Use the <b>:</b> (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the <code>ProductStatus</code> attribute was one of the following:</p>
|
826 1001 | /// <p><code>Available | Backordered | Discontinued</code></p>
|
827 1002 | /// <p>You would first need to specify <code>ExpressionAttributeValues</code> as follows:</p>
|
828 1003 | /// <p><code>{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }</code></p>
|
829 1004 | /// <p>You could then use these values in an expression, such as this:</p>
|
830 1005 | /// <p><code>ProductStatus IN (:avail, :back, :disc)</code></p>
|
831 1006 | /// <p>For more information on expression attribute values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Condition Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
1007 + | /* BuilderGenerator.kt:314 */
|
832 1008 | pub fn set_expression_attribute_values(
|
833 1009 | mut self,
|
834 1010 | input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
|
835 1011 | ) -> Self {
|
1012 + | /* BuilderGenerator.kt:315 */
|
836 1013 | self.expression_attribute_values = input;
|
837 1014 | self
|
1015 + | /* BuilderGenerator.kt:314 */
|
838 1016 | }
|
839 - | /// <p>One or more values that can be substituted in an expression.</p>
|
1017 + | /// /* BuilderGenerator.kt:334 */<p>One or more values that can be substituted in an expression.</p>
|
840 1018 | /// <p>Use the <b>:</b> (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the <code>ProductStatus</code> attribute was one of the following:</p>
|
841 1019 | /// <p><code>Available | Backordered | Discontinued</code></p>
|
842 1020 | /// <p>You would first need to specify <code>ExpressionAttributeValues</code> as follows:</p>
|
843 1021 | /// <p><code>{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }</code></p>
|
844 1022 | /// <p>You could then use these values in an expression, such as this:</p>
|
845 1023 | /// <p><code>ProductStatus IN (:avail, :back, :disc)</code></p>
|
846 1024 | /// <p>For more information on expression attribute values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Condition Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
1025 + | /* BuilderGenerator.kt:336 */
|
847 1026 | pub fn get_expression_attribute_values(
|
848 1027 | &self,
|
849 1028 | ) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>> {
|
1029 + | /* BuilderGenerator.kt:337 */
|
850 1030 | &self.expression_attribute_values
|
1031 + | /* BuilderGenerator.kt:336 */
|
851 1032 | }
|
852 - | /// Consumes the builder and constructs a [`UpdateItemInput`](crate::operation::update_item::UpdateItemInput).
|
1033 + | /// /* BuilderGenerator.kt:240 */Consumes the builder and constructs a [`UpdateItemInput`](crate::operation::update_item::UpdateItemInput).
|
1034 + | /* BuilderGenerator.kt:253 */
|
853 1035 | pub fn build(self) -> ::std::result::Result<crate::operation::update_item::UpdateItemInput, ::aws_smithy_types::error::operation::BuildError> {
|
854 - | ::std::result::Result::Ok(crate::operation::update_item::UpdateItemInput {
|
855 - | table_name: self.table_name,
|
1036 + | /* BuilderGenerator.kt:254 */
|
1037 + | ::std::result::Result::Ok(
|
1038 + | /* BuilderGenerator.kt:477 */
|
1039 + | crate::operation::update_item::UpdateItemInput {
|
1040 + | /* BuilderGenerator.kt:481 */ table_name: self.table_name,
|
1041 + | /* BuilderGenerator.kt:481 */
|
856 1042 | key: self.key,
|
1043 + | /* BuilderGenerator.kt:481 */
|
857 1044 | attribute_updates: self.attribute_updates,
|
1045 + | /* BuilderGenerator.kt:481 */
|
858 1046 | expected: self.expected,
|
1047 + | /* BuilderGenerator.kt:481 */
|
859 1048 | conditional_operator: self.conditional_operator,
|
1049 + | /* BuilderGenerator.kt:481 */
|
860 1050 | return_values: self.return_values,
|
1051 + | /* BuilderGenerator.kt:481 */
|
861 1052 | return_consumed_capacity: self.return_consumed_capacity,
|
1053 + | /* BuilderGenerator.kt:481 */
|
862 1054 | return_item_collection_metrics: self.return_item_collection_metrics,
|
1055 + | /* BuilderGenerator.kt:481 */
|
863 1056 | update_expression: self.update_expression,
|
1057 + | /* BuilderGenerator.kt:481 */
|
864 1058 | condition_expression: self.condition_expression,
|
1059 + | /* BuilderGenerator.kt:481 */
|
865 1060 | expression_attribute_names: self.expression_attribute_names,
|
1061 + | /* BuilderGenerator.kt:481 */
|
866 1062 | expression_attribute_values: self.expression_attribute_values,
|
867 - | })
|
1063 + | /* BuilderGenerator.kt:477 */
|
1064 + | }, /* BuilderGenerator.kt:254 */
|
1065 + | )
|
1066 + | /* BuilderGenerator.kt:253 */
|
868 1067 | }
|
1068 + | /* BuilderGenerator.kt:355 */
|
869 1069 | }
|