1 1 | // Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
|
2 - |
|
3 - | /// <p>Represents the selection criteria for a <code>Query</code> or <code>Scan</code> operation:</p>
|
2 + | /* StructureGenerator.kt:197 */
|
3 + | /// /* StructureGenerator.kt:197 */<p>Represents the selection criteria for a <code>Query</code> or <code>Scan</code> operation:</p>
|
4 4 | /// <ul>
|
5 5 | /// <li>
|
6 6 | /// <p>For a <code>Query</code> operation, <code>Condition</code> is used for specifying the <code>KeyConditions</code> to use when querying a table or an index. For <code>KeyConditions</code>, only the following comparison operators are supported:</p>
|
7 7 | /// <p><code>EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN</code></p>
|
8 8 | /// <p><code>Condition</code> is also used in a <code>QueryFilter</code>, which evaluates the query results and returns only the desired values.</p></li>
|
9 9 | /// <li>
|
10 10 | /// <p>For a <code>Scan</code> operation, <code>Condition</code> is used in a <code>ScanFilter</code>, which evaluates the scan results and returns only the desired values.</p></li>
|
11 11 | /// </ul>
|
12 + | /* RustType.kt:516 */
|
12 13 | #[non_exhaustive]
|
14 + | /* RustType.kt:516 */
|
13 15 | #[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
|
14 - | pub struct Condition {
|
15 - | /// <p>One or more values to evaluate against the supplied attribute. The number of values in the list depends on the <code>ComparisonOperator</code> being used.</p>
|
16 + | pub /* StructureGenerator.kt:201 */ struct Condition {
|
17 + | /// /* StructureGenerator.kt:231 */<p>One or more values to evaluate against the supplied attribute. The number of values in the list depends on the <code>ComparisonOperator</code> being used.</p>
|
16 18 | /// <p>For type Number, value comparisons are numeric.</p>
|
17 19 | /// <p>String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>a</code> is greater than <code>B</code>. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>.</p>
|
18 20 | /// <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.</p>
|
19 21 | pub attribute_value_list: ::std::option::Option<::std::vec::Vec<crate::types::AttributeValue>>,
|
20 - | /// <p>A comparator for evaluating attributes. For example, equals, greater than, less than, etc.</p>
|
22 + | /// /* StructureGenerator.kt:231 */<p>A comparator for evaluating attributes. For example, equals, greater than, less than, etc.</p>
|
21 23 | /// <p>The following comparison operators are available:</p>
|
22 24 | /// <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p>
|
23 25 | /// <p>The following are descriptions of each comparison operator.</p>
|
24 26 | /// <ul>
|
25 27 | /// <li>
|
26 28 | /// <p><code>EQ</code> : Equal. <code>EQ</code> is supported for all data types, including lists and maps.</p>
|
27 29 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not equal <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
28 30 | /// <p></p></li>
|
29 31 | /// <li>
|
30 32 | /// <p><code>NE</code> : Not equal. <code>NE</code> is supported for all data types, including lists and maps.</p>
|
31 33 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <code>AttributeValue</code> of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not equal <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
32 34 | /// <p></p></li>
|
33 35 | /// <li>
|
34 36 | /// <p><code>LE</code> : Less than or equal.</p>
|
35 37 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
36 38 | /// <p></p></li>
|
37 39 | /// <li>
|
38 40 | /// <p><code>LT</code> : Less than.</p>
|
39 41 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> of type String, Number, or Binary (not a set type). If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
40 42 | /// <p></p></li>
|
41 43 | /// <li>
|
42 44 | /// <p><code>GE</code> : Greater than or equal.</p>
|
43 45 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
44 46 | /// <p></p></li>
|
45 47 | /// <li>
|
46 48 | /// <p><code>GT</code> : Greater than.</p>
|
47 49 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
48 50 | /// <p></p></li>
|
49 51 | /// <li>
|
50 52 | /// <p><code>NOT_NULL</code> : The attribute exists. <code>NOT_NULL</code> is supported for all data types, including lists and maps.</p><note>
|
51 53 | /// <p>This operator tests for the existence of an attribute, not its data type. If the data type of attribute "<code>a</code>" is null, and you evaluate it using <code>NOT_NULL</code>, the result is a Boolean <code>true</code>. This result is because the attribute "<code>a</code>" exists; its data type is not relevant to the <code>NOT_NULL</code> comparison operator.</p>
|
52 54 | /// </note></li>
|
53 55 | /// <li>
|
54 56 | /// <p><code>NULL</code> : The attribute does not exist. <code>NULL</code> is supported for all data types, including lists and maps.</p><note>
|
55 57 | /// <p>This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "<code>a</code>" is null, and you evaluate it using <code>NULL</code>, the result is a Boolean <code>false</code>. This is because the attribute "<code>a</code>" exists; its data type is not relevant to the <code>NULL</code> comparison operator.</p>
|
56 58 | /// </note></li>
|
57 59 | /// <li>
|
58 60 | /// <p><code>CONTAINS</code> : Checks for a subsequence, or value in a set.</p>
|
59 61 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("<code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the operator evaluates to true if it finds an exact match with any member of the set.</p>
|
60 62 | /// <p>CONTAINS is supported for lists: When evaluating "<code>a CONTAINS b</code>", "<code>a</code>" can be a list; however, "<code>b</code>" cannot be a set, a map, or a list.</p></li>
|
61 63 | /// <li>
|
62 64 | /// <p><code>NOT_CONTAINS</code> : Checks for absence of a subsequence, or absence of a value in a set.</p>
|
63 65 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("<code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the operator evaluates to true if it <i>does not</i> find an exact match with any member of the set.</p>
|
64 66 | /// <p>NOT_CONTAINS is supported for lists: When evaluating "<code>a NOT CONTAINS b</code>", "<code>a</code>" can be a list; however, "<code>b</code>" cannot be a set, a map, or a list.</p></li>
|
65 67 | /// <li>
|
66 68 | /// <p><code>BEGINS_WITH</code> : Checks for a prefix.</p>
|
67 69 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).</p>
|
68 70 | /// <p></p></li>
|
69 71 | /// <li>
|
70 72 | /// <p><code>IN</code> : Checks for matching elements in a list.</p>
|
71 73 | /// <p><code>AttributeValueList</code> can contain one or more <code>AttributeValue</code> elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.</p></li>
|
72 74 | /// <li>
|
73 75 | /// <p><code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal to the second value.</p>
|
74 76 | /// <p><code>AttributeValueList</code> must contain two <code>AttributeValue</code> elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not compare to <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code></p></li>
|
75 77 | /// </ul>
|
76 78 | /// <p>For usage examples of <code>AttributeValueList</code> and <code>ComparisonOperator</code>, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html">Legacy Conditional Parameters</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
77 79 | pub comparison_operator: crate::types::ComparisonOperator,
|
80 + | /* StructureGenerator.kt:201 */
|
78 81 | }
|
82 + | /* StructureGenerator.kt:135 */
|
79 83 | impl Condition {
|
80 - | /// <p>One or more values to evaluate against the supplied attribute. The number of values in the list depends on the <code>ComparisonOperator</code> being used.</p>
|
84 + | /// /* StructureGenerator.kt:231 */<p>One or more values to evaluate against the supplied attribute. The number of values in the list depends on the <code>ComparisonOperator</code> being used.</p>
|
81 85 | /// <p>For type Number, value comparisons are numeric.</p>
|
82 86 | /// <p>String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>a</code> is greater than <code>B</code>. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>.</p>
|
83 87 | /// <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.</p>
|
84 - | ///
|
85 - | /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.attribute_value_list.is_none()`.
|
88 + | /// /* StructureGenerator.kt:162 */
|
89 + | /// /* StructureGenerator.kt:163 */If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.attribute_value_list.is_none()`.
|
90 + | /* StructureGenerator.kt:166 */
|
86 91 | pub fn attribute_value_list(&self) -> &[crate::types::AttributeValue] {
|
87 - | self.attribute_value_list.as_deref().unwrap_or_default()
|
92 + | /* StructureGenerator.kt:169 */
|
93 + | self.attribute_value_list
|
94 + | .as_deref()
|
95 + | /* StructureGenerator.kt:175 */
|
96 + | .unwrap_or_default()
|
97 + | /* StructureGenerator.kt:166 */
|
88 98 | }
|
89 - | /// <p>A comparator for evaluating attributes. For example, equals, greater than, less than, etc.</p>
|
99 + | /// /* StructureGenerator.kt:231 */<p>A comparator for evaluating attributes. For example, equals, greater than, less than, etc.</p>
|
90 100 | /// <p>The following comparison operators are available:</p>
|
91 101 | /// <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p>
|
92 102 | /// <p>The following are descriptions of each comparison operator.</p>
|
93 103 | /// <ul>
|
94 104 | /// <li>
|
95 105 | /// <p><code>EQ</code> : Equal. <code>EQ</code> is supported for all data types, including lists and maps.</p>
|
96 106 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not equal <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
97 107 | /// <p></p></li>
|
98 108 | /// <li>
|
99 109 | /// <p><code>NE</code> : Not equal. <code>NE</code> is supported for all data types, including lists and maps.</p>
|
100 110 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <code>AttributeValue</code> of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not equal <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
101 111 | /// <p></p></li>
|
102 112 | /// <li>
|
103 113 | /// <p><code>LE</code> : Less than or equal.</p>
|
104 114 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
105 115 | /// <p></p></li>
|
106 116 | /// <li>
|
107 117 | /// <p><code>LT</code> : Less than.</p>
|
108 118 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> of type String, Number, or Binary (not a set type). If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
109 119 | /// <p></p></li>
|
110 120 | /// <li>
|
111 121 | /// <p><code>GE</code> : Greater than or equal.</p>
|
112 122 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
113 123 | /// <p></p></li>
|
114 124 | /// <li>
|
115 125 | /// <p><code>GT</code> : Greater than.</p>
|
116 126 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
117 127 | /// <p></p></li>
|
118 128 | /// <li>
|
119 129 | /// <p><code>NOT_NULL</code> : The attribute exists. <code>NOT_NULL</code> is supported for all data types, including lists and maps.</p><note>
|
120 130 | /// <p>This operator tests for the existence of an attribute, not its data type. If the data type of attribute "<code>a</code>" is null, and you evaluate it using <code>NOT_NULL</code>, the result is a Boolean <code>true</code>. This result is because the attribute "<code>a</code>" exists; its data type is not relevant to the <code>NOT_NULL</code> comparison operator.</p>
|
121 131 | /// </note></li>
|
122 132 | /// <li>
|
123 133 | /// <p><code>NULL</code> : The attribute does not exist. <code>NULL</code> is supported for all data types, including lists and maps.</p><note>
|
124 134 | /// <p>This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "<code>a</code>" is null, and you evaluate it using <code>NULL</code>, the result is a Boolean <code>false</code>. This is because the attribute "<code>a</code>" exists; its data type is not relevant to the <code>NULL</code> comparison operator.</p>
|
125 135 | /// </note></li>
|
126 136 | /// <li>
|
127 137 | /// <p><code>CONTAINS</code> : Checks for a subsequence, or value in a set.</p>
|
128 138 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("<code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the operator evaluates to true if it finds an exact match with any member of the set.</p>
|
129 139 | /// <p>CONTAINS is supported for lists: When evaluating "<code>a CONTAINS b</code>", "<code>a</code>" can be a list; however, "<code>b</code>" cannot be a set, a map, or a list.</p></li>
|
130 140 | /// <li>
|
131 141 | /// <p><code>NOT_CONTAINS</code> : Checks for absence of a subsequence, or absence of a value in a set.</p>
|
132 142 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("<code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the operator evaluates to true if it <i>does not</i> find an exact match with any member of the set.</p>
|
133 143 | /// <p>NOT_CONTAINS is supported for lists: When evaluating "<code>a NOT CONTAINS b</code>", "<code>a</code>" can be a list; however, "<code>b</code>" cannot be a set, a map, or a list.</p></li>
|
134 144 | /// <li>
|
135 145 | /// <p><code>BEGINS_WITH</code> : Checks for a prefix.</p>
|
136 146 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).</p>
|
137 147 | /// <p></p></li>
|
138 148 | /// <li>
|
139 149 | /// <p><code>IN</code> : Checks for matching elements in a list.</p>
|
140 150 | /// <p><code>AttributeValueList</code> can contain one or more <code>AttributeValue</code> elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.</p></li>
|
141 151 | /// <li>
|
142 152 | /// <p><code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal to the second value.</p>
|
143 153 | /// <p><code>AttributeValueList</code> must contain two <code>AttributeValue</code> elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not compare to <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code></p></li>
|
144 154 | /// </ul>
|
145 155 | /// <p>For usage examples of <code>AttributeValueList</code> and <code>ComparisonOperator</code>, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html">Legacy Conditional Parameters</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
156 + | /* StructureGenerator.kt:166 */
|
146 157 | pub fn comparison_operator(&self) -> &crate::types::ComparisonOperator {
|
158 + | /* StructureGenerator.kt:172 */
|
147 159 | &self.comparison_operator
|
160 + | /* StructureGenerator.kt:166 */
|
148 161 | }
|
162 + | /* StructureGenerator.kt:135 */
|
149 163 | }
|
164 + | /* ClientCodegenVisitor.kt:237 */
|
150 165 | impl Condition {
|
151 - | /// Creates a new builder-style object to manufacture [`Condition`](crate::types::Condition).
|
166 + | /// /* BuilderGenerator.kt:173 */Creates a new builder-style object to manufacture [`Condition`](crate::types::Condition).
|
167 + | /* BuilderGenerator.kt:175 */
|
152 168 | pub fn builder() -> crate::types::builders::ConditionBuilder {
|
169 + | /* BuilderGenerator.kt:176 */
|
153 170 | crate::types::builders::ConditionBuilder::default()
|
171 + | /* BuilderGenerator.kt:175 */
|
154 172 | }
|
173 + | /* ClientCodegenVisitor.kt:237 */
|
155 174 | }
|
156 175 |
|
157 - | /// A builder for [`Condition`](crate::types::Condition).
|
176 + | /// /* BuilderGenerator.kt:342 */A builder for [`Condition`](crate::types::Condition).
|
177 + | /* RustType.kt:516 */
|
158 178 | #[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
|
179 + | /* RustType.kt:516 */
|
159 180 | #[non_exhaustive]
|
181 + | /* BuilderGenerator.kt:345 */
|
160 182 | pub struct ConditionBuilder {
|
161 - | pub(crate) attribute_value_list: ::std::option::Option<::std::vec::Vec<crate::types::AttributeValue>>,
|
183 + | /* BuilderGenerator.kt:275 */ pub(crate) attribute_value_list: ::std::option::Option<::std::vec::Vec<crate::types::AttributeValue>>,
|
184 + | /* BuilderGenerator.kt:275 */
|
162 185 | pub(crate) comparison_operator: ::std::option::Option<crate::types::ComparisonOperator>,
|
186 + | /* BuilderGenerator.kt:345 */
|
163 187 | }
|
188 + | /* BuilderGenerator.kt:355 */
|
164 189 | impl ConditionBuilder {
|
165 - | /// Appends an item to `attribute_value_list`.
|
190 + | /// /* BuilderGenerator.kt:410 */Appends an item to `attribute_value_list`.
|
191 + | /* BuilderGenerator.kt:411 */
|
166 192 | ///
|
167 - | /// To override the contents of this collection use [`set_attribute_value_list`](Self::set_attribute_value_list).
|
193 + | /// /* BuilderGenerator.kt:412 */To override the contents of this collection use [`set_attribute_value_list`](Self::set_attribute_value_list).
|
194 + | /* BuilderGenerator.kt:413 */
|
168 195 | ///
|
169 - | /// <p>One or more values to evaluate against the supplied attribute. The number of values in the list depends on the <code>ComparisonOperator</code> being used.</p>
|
196 + | /// /* BuilderGenerator.kt:414 */<p>One or more values to evaluate against the supplied attribute. The number of values in the list depends on the <code>ComparisonOperator</code> being used.</p>
|
170 197 | /// <p>For type Number, value comparisons are numeric.</p>
|
171 198 | /// <p>String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>a</code> is greater than <code>B</code>. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>.</p>
|
172 199 | /// <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.</p>
|
200 + | /* BuilderGenerator.kt:418 */
|
173 201 | pub fn attribute_value_list(mut self, input: crate::types::AttributeValue) -> Self {
|
202 + | /* BuilderGenerator.kt:419 */
|
174 203 | let mut v = self.attribute_value_list.unwrap_or_default();
|
175 204 | v.push(input);
|
176 205 | self.attribute_value_list = ::std::option::Option::Some(v);
|
177 206 | self
|
207 + | /* BuilderGenerator.kt:418 */
|
178 208 | }
|
179 - | /// <p>One or more values to evaluate against the supplied attribute. The number of values in the list depends on the <code>ComparisonOperator</code> being used.</p>
|
209 + | /// /* BuilderGenerator.kt:312 */<p>One or more values to evaluate against the supplied attribute. The number of values in the list depends on the <code>ComparisonOperator</code> being used.</p>
|
180 210 | /// <p>For type Number, value comparisons are numeric.</p>
|
181 211 | /// <p>String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>a</code> is greater than <code>B</code>. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>.</p>
|
182 212 | /// <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.</p>
|
213 + | /* BuilderGenerator.kt:314 */
|
183 214 | pub fn set_attribute_value_list(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::AttributeValue>>) -> Self {
|
215 + | /* BuilderGenerator.kt:315 */
|
184 216 | self.attribute_value_list = input;
|
185 217 | self
|
218 + | /* BuilderGenerator.kt:314 */
|
186 219 | }
|
187 - | /// <p>One or more values to evaluate against the supplied attribute. The number of values in the list depends on the <code>ComparisonOperator</code> being used.</p>
|
220 + | /// /* BuilderGenerator.kt:334 */<p>One or more values to evaluate against the supplied attribute. The number of values in the list depends on the <code>ComparisonOperator</code> being used.</p>
|
188 221 | /// <p>For type Number, value comparisons are numeric.</p>
|
189 222 | /// <p>String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>a</code> is greater than <code>B</code>. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>.</p>
|
190 223 | /// <p>For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.</p>
|
224 + | /* BuilderGenerator.kt:336 */
|
191 225 | pub fn get_attribute_value_list(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AttributeValue>> {
|
226 + | /* BuilderGenerator.kt:337 */
|
192 227 | &self.attribute_value_list
|
228 + | /* BuilderGenerator.kt:336 */
|
193 229 | }
|
194 - | /// <p>A comparator for evaluating attributes. For example, equals, greater than, less than, etc.</p>
|
230 + | /// /* BuilderGenerator.kt:286 */<p>A comparator for evaluating attributes. For example, equals, greater than, less than, etc.</p>
|
195 231 | /// <p>The following comparison operators are available:</p>
|
196 232 | /// <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p>
|
197 233 | /// <p>The following are descriptions of each comparison operator.</p>
|
198 234 | /// <ul>
|
199 235 | /// <li>
|
200 236 | /// <p><code>EQ</code> : Equal. <code>EQ</code> is supported for all data types, including lists and maps.</p>
|
201 237 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not equal <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
202 238 | /// <p></p></li>
|
203 239 | /// <li>
|
204 240 | /// <p><code>NE</code> : Not equal. <code>NE</code> is supported for all data types, including lists and maps.</p>
|
205 241 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <code>AttributeValue</code> of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not equal <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
206 242 | /// <p></p></li>
|
207 243 | /// <li>
|
208 244 | /// <p><code>LE</code> : Less than or equal.</p>
|
209 245 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
210 246 | /// <p></p></li>
|
211 247 | /// <li>
|
212 248 | /// <p><code>LT</code> : Less than.</p>
|
213 249 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> of type String, Number, or Binary (not a set type). If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
214 250 | /// <p></p></li>
|
215 251 | /// <li>
|
216 252 | /// <p><code>GE</code> : Greater than or equal.</p>
|
217 253 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
218 254 | /// <p></p></li>
|
219 255 | /// <li>
|
220 256 | /// <p><code>GT</code> : Greater than.</p>
|
221 257 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
222 258 | /// <p></p></li>
|
223 259 | /// <li>
|
224 260 | /// <p><code>NOT_NULL</code> : The attribute exists. <code>NOT_NULL</code> is supported for all data types, including lists and maps.</p><note>
|
225 261 | /// <p>This operator tests for the existence of an attribute, not its data type. If the data type of attribute "<code>a</code>" is null, and you evaluate it using <code>NOT_NULL</code>, the result is a Boolean <code>true</code>. This result is because the attribute "<code>a</code>" exists; its data type is not relevant to the <code>NOT_NULL</code> comparison operator.</p>
|
226 262 | /// </note></li>
|
227 263 | /// <li>
|
228 264 | /// <p><code>NULL</code> : The attribute does not exist. <code>NULL</code> is supported for all data types, including lists and maps.</p><note>
|
229 265 | /// <p>This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "<code>a</code>" is null, and you evaluate it using <code>NULL</code>, the result is a Boolean <code>false</code>. This is because the attribute "<code>a</code>" exists; its data type is not relevant to the <code>NULL</code> comparison operator.</p>
|
230 266 | /// </note></li>
|
231 267 | /// <li>
|
232 268 | /// <p><code>CONTAINS</code> : Checks for a subsequence, or value in a set.</p>
|
233 269 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("<code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the operator evaluates to true if it finds an exact match with any member of the set.</p>
|
234 270 | /// <p>CONTAINS is supported for lists: When evaluating "<code>a CONTAINS b</code>", "<code>a</code>" can be a list; however, "<code>b</code>" cannot be a set, a map, or a list.</p></li>
|
235 271 | /// <li>
|
236 272 | /// <p><code>NOT_CONTAINS</code> : Checks for absence of a subsequence, or absence of a value in a set.</p>
|
237 273 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("<code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the operator evaluates to true if it <i>does not</i> find an exact match with any member of the set.</p>
|
238 274 | /// <p>NOT_CONTAINS is supported for lists: When evaluating "<code>a NOT CONTAINS b</code>", "<code>a</code>" can be a list; however, "<code>b</code>" cannot be a set, a map, or a list.</p></li>
|
239 275 | /// <li>
|
240 276 | /// <p><code>BEGINS_WITH</code> : Checks for a prefix.</p>
|
241 277 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).</p>
|
242 278 | /// <p></p></li>
|
243 279 | /// <li>
|
244 280 | /// <p><code>IN</code> : Checks for matching elements in a list.</p>
|
245 281 | /// <p><code>AttributeValueList</code> can contain one or more <code>AttributeValue</code> elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.</p></li>
|
246 282 | /// <li>
|
247 283 | /// <p><code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal to the second value.</p>
|
248 284 | /// <p><code>AttributeValueList</code> must contain two <code>AttributeValue</code> elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not compare to <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code></p></li>
|
249 285 | /// </ul>
|
250 286 | /// <p>For usage examples of <code>AttributeValueList</code> and <code>ComparisonOperator</code>, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html">Legacy Conditional Parameters</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
251 - | /// This field is required.
|
287 + | /// /* BuilderGenerator.kt:288 */This field is required.
|
288 + | /* BuilderGenerator.kt:291 */
|
252 289 | pub fn comparison_operator(mut self, input: crate::types::ComparisonOperator) -> Self {
|
290 + | /* BuilderGenerator.kt:292 */
|
253 291 | self.comparison_operator = ::std::option::Option::Some(input);
|
292 + | /* BuilderGenerator.kt:293 */
|
254 293 | self
|
294 + | /* BuilderGenerator.kt:291 */
|
255 295 | }
|
256 - | /// <p>A comparator for evaluating attributes. For example, equals, greater than, less than, etc.</p>
|
296 + | /// /* BuilderGenerator.kt:312 */<p>A comparator for evaluating attributes. For example, equals, greater than, less than, etc.</p>
|
257 297 | /// <p>The following comparison operators are available:</p>
|
258 298 | /// <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p>
|
259 299 | /// <p>The following are descriptions of each comparison operator.</p>
|
260 300 | /// <ul>
|
261 301 | /// <li>
|
262 302 | /// <p><code>EQ</code> : Equal. <code>EQ</code> is supported for all data types, including lists and maps.</p>
|
263 303 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not equal <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
264 304 | /// <p></p></li>
|
265 305 | /// <li>
|
266 306 | /// <p><code>NE</code> : Not equal. <code>NE</code> is supported for all data types, including lists and maps.</p>
|
267 307 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <code>AttributeValue</code> of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not equal <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
268 308 | /// <p></p></li>
|
269 309 | /// <li>
|
270 310 | /// <p><code>LE</code> : Less than or equal.</p>
|
271 311 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
272 312 | /// <p></p></li>
|
273 313 | /// <li>
|
274 314 | /// <p><code>LT</code> : Less than.</p>
|
275 315 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> of type String, Number, or Binary (not a set type). If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
276 316 | /// <p></p></li>
|
277 317 | /// <li>
|
278 318 | /// <p><code>GE</code> : Greater than or equal.</p>
|
279 319 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
280 320 | /// <p></p></li>
|
281 321 | /// <li>
|
282 322 | /// <p><code>GT</code> : Greater than.</p>
|
283 323 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
284 324 | /// <p></p></li>
|
285 325 | /// <li>
|
286 326 | /// <p><code>NOT_NULL</code> : The attribute exists. <code>NOT_NULL</code> is supported for all data types, including lists and maps.</p><note>
|
287 327 | /// <p>This operator tests for the existence of an attribute, not its data type. If the data type of attribute "<code>a</code>" is null, and you evaluate it using <code>NOT_NULL</code>, the result is a Boolean <code>true</code>. This result is because the attribute "<code>a</code>" exists; its data type is not relevant to the <code>NOT_NULL</code> comparison operator.</p>
|
288 328 | /// </note></li>
|
289 329 | /// <li>
|
290 330 | /// <p><code>NULL</code> : The attribute does not exist. <code>NULL</code> is supported for all data types, including lists and maps.</p><note>
|
291 331 | /// <p>This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "<code>a</code>" is null, and you evaluate it using <code>NULL</code>, the result is a Boolean <code>false</code>. This is because the attribute "<code>a</code>" exists; its data type is not relevant to the <code>NULL</code> comparison operator.</p>
|
292 332 | /// </note></li>
|
293 333 | /// <li>
|
294 334 | /// <p><code>CONTAINS</code> : Checks for a subsequence, or value in a set.</p>
|
295 335 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("<code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the operator evaluates to true if it finds an exact match with any member of the set.</p>
|
296 336 | /// <p>CONTAINS is supported for lists: When evaluating "<code>a CONTAINS b</code>", "<code>a</code>" can be a list; however, "<code>b</code>" cannot be a set, a map, or a list.</p></li>
|
297 337 | /// <li>
|
298 338 | /// <p><code>NOT_CONTAINS</code> : Checks for absence of a subsequence, or absence of a value in a set.</p>
|
299 339 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("<code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the operator evaluates to true if it <i>does not</i> find an exact match with any member of the set.</p>
|
300 340 | /// <p>NOT_CONTAINS is supported for lists: When evaluating "<code>a NOT CONTAINS b</code>", "<code>a</code>" can be a list; however, "<code>b</code>" cannot be a set, a map, or a list.</p></li>
|
301 341 | /// <li>
|
302 342 | /// <p><code>BEGINS_WITH</code> : Checks for a prefix.</p>
|
303 343 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).</p>
|
304 344 | /// <p></p></li>
|
305 345 | /// <li>
|
306 346 | /// <p><code>IN</code> : Checks for matching elements in a list.</p>
|
307 347 | /// <p><code>AttributeValueList</code> can contain one or more <code>AttributeValue</code> elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.</p></li>
|
308 348 | /// <li>
|
309 349 | /// <p><code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal to the second value.</p>
|
310 350 | /// <p><code>AttributeValueList</code> must contain two <code>AttributeValue</code> elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not compare to <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code></p></li>
|
311 351 | /// </ul>
|
312 352 | /// <p>For usage examples of <code>AttributeValueList</code> and <code>ComparisonOperator</code>, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html">Legacy Conditional Parameters</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
353 + | /* BuilderGenerator.kt:314 */
|
313 354 | pub fn set_comparison_operator(mut self, input: ::std::option::Option<crate::types::ComparisonOperator>) -> Self {
|
355 + | /* BuilderGenerator.kt:315 */
|
314 356 | self.comparison_operator = input;
|
315 357 | self
|
358 + | /* BuilderGenerator.kt:314 */
|
316 359 | }
|
317 - | /// <p>A comparator for evaluating attributes. For example, equals, greater than, less than, etc.</p>
|
360 + | /// /* BuilderGenerator.kt:334 */<p>A comparator for evaluating attributes. For example, equals, greater than, less than, etc.</p>
|
318 361 | /// <p>The following comparison operators are available:</p>
|
319 362 | /// <p><code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code></p>
|
320 363 | /// <p>The following are descriptions of each comparison operator.</p>
|
321 364 | /// <ul>
|
322 365 | /// <li>
|
323 366 | /// <p><code>EQ</code> : Equal. <code>EQ</code> is supported for all data types, including lists and maps.</p>
|
324 367 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not equal <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
325 368 | /// <p></p></li>
|
326 369 | /// <li>
|
327 370 | /// <p><code>NE</code> : Not equal. <code>NE</code> is supported for all data types, including lists and maps.</p>
|
328 371 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <code>AttributeValue</code> of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not equal <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
329 372 | /// <p></p></li>
|
330 373 | /// <li>
|
331 374 | /// <p><code>LE</code> : Less than or equal.</p>
|
332 375 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
333 376 | /// <p></p></li>
|
334 377 | /// <li>
|
335 378 | /// <p><code>LT</code> : Less than.</p>
|
336 379 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> of type String, Number, or Binary (not a set type). If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
337 380 | /// <p></p></li>
|
338 381 | /// <li>
|
339 382 | /// <p><code>GE</code> : Greater than or equal.</p>
|
340 383 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
341 384 | /// <p></p></li>
|
342 385 | /// <li>
|
343 386 | /// <p><code>GT</code> : Greater than.</p>
|
344 387 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code>.</p>
|
345 388 | /// <p></p></li>
|
346 389 | /// <li>
|
347 390 | /// <p><code>NOT_NULL</code> : The attribute exists. <code>NOT_NULL</code> is supported for all data types, including lists and maps.</p><note>
|
348 391 | /// <p>This operator tests for the existence of an attribute, not its data type. If the data type of attribute "<code>a</code>" is null, and you evaluate it using <code>NOT_NULL</code>, the result is a Boolean <code>true</code>. This result is because the attribute "<code>a</code>" exists; its data type is not relevant to the <code>NOT_NULL</code> comparison operator.</p>
|
349 392 | /// </note></li>
|
350 393 | /// <li>
|
351 394 | /// <p><code>NULL</code> : The attribute does not exist. <code>NULL</code> is supported for all data types, including lists and maps.</p><note>
|
352 395 | /// <p>This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "<code>a</code>" is null, and you evaluate it using <code>NULL</code>, the result is a Boolean <code>false</code>. This is because the attribute "<code>a</code>" exists; its data type is not relevant to the <code>NULL</code> comparison operator.</p>
|
353 396 | /// </note></li>
|
354 397 | /// <li>
|
355 398 | /// <p><code>CONTAINS</code> : Checks for a subsequence, or value in a set.</p>
|
356 399 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("<code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the operator evaluates to true if it finds an exact match with any member of the set.</p>
|
357 400 | /// <p>CONTAINS is supported for lists: When evaluating "<code>a CONTAINS b</code>", "<code>a</code>" can be a list; however, "<code>b</code>" cannot be a set, a map, or a list.</p></li>
|
358 401 | /// <li>
|
359 402 | /// <p><code>NOT_CONTAINS</code> : Checks for absence of a subsequence, or absence of a value in a set.</p>
|
360 403 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("<code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the operator evaluates to true if it <i>does not</i> find an exact match with any member of the set.</p>
|
361 404 | /// <p>NOT_CONTAINS is supported for lists: When evaluating "<code>a NOT CONTAINS b</code>", "<code>a</code>" can be a list; however, "<code>b</code>" cannot be a set, a map, or a list.</p></li>
|
362 405 | /// <li>
|
363 406 | /// <p><code>BEGINS_WITH</code> : Checks for a prefix.</p>
|
364 407 | /// <p><code>AttributeValueList</code> can contain only one <code>AttributeValue</code> of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).</p>
|
365 408 | /// <p></p></li>
|
366 409 | /// <li>
|
367 410 | /// <p><code>IN</code> : Checks for matching elements in a list.</p>
|
368 411 | /// <p><code>AttributeValueList</code> can contain one or more <code>AttributeValue</code> elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.</p></li>
|
369 412 | /// <li>
|
370 413 | /// <p><code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal to the second value.</p>
|
371 414 | /// <p><code>AttributeValueList</code> must contain two <code>AttributeValue</code> elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an <code>AttributeValue</code> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not compare to <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":\["6", "2", "1"\]}</code></p></li>
|
372 415 | /// </ul>
|
373 416 | /// <p>For usage examples of <code>AttributeValueList</code> and <code>ComparisonOperator</code>, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html">Legacy Conditional Parameters</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
417 + | /* BuilderGenerator.kt:336 */
|
374 418 | pub fn get_comparison_operator(&self) -> &::std::option::Option<crate::types::ComparisonOperator> {
|
419 + | /* BuilderGenerator.kt:337 */
|
375 420 | &self.comparison_operator
|
421 + | /* BuilderGenerator.kt:336 */
|
376 422 | }
|
377 - | /// Consumes the builder and constructs a [`Condition`](crate::types::Condition).
|
378 - | /// This method will fail if any of the following fields are not set:
|
379 - | /// - [`comparison_operator`](crate::types::builders::ConditionBuilder::comparison_operator)
|
423 + | /// /* BuilderGenerator.kt:240 */Consumes the builder and constructs a [`Condition`](crate::types::Condition).
|
424 + | /// /* BuilderGenerator.kt:243 */This method will fail if any of the following fields are not set:
|
425 + | /// /* BuilderGenerator.kt:246 */- [`comparison_operator`](crate::types::builders::ConditionBuilder::comparison_operator)
|
426 + | /* BuilderGenerator.kt:253 */
|
380 427 | pub fn build(self) -> ::std::result::Result<crate::types::Condition, ::aws_smithy_types::error::operation::BuildError> {
|
381 - | ::std::result::Result::Ok(crate::types::Condition {
|
382 - | attribute_value_list: self.attribute_value_list,
|
383 - | comparison_operator: self.comparison_operator.ok_or_else(|| {
|
384 - | ::aws_smithy_types::error::operation::BuildError::missing_field(
|
385 - | "comparison_operator",
|
386 - | "comparison_operator was not specified but it is required when building Condition",
|
387 - | )
|
388 - | })?,
|
389 - | })
|
428 + | /* BuilderGenerator.kt:254 */
|
429 + | ::std::result::Result::Ok(
|
430 + | /* BuilderGenerator.kt:477 */crate::types::Condition {
|
431 + | /* BuilderGenerator.kt:481 */attribute_value_list: self.attribute_value_list
|
432 + | ,
|
433 + | /* BuilderGenerator.kt:481 */comparison_operator: self.comparison_operator
|
434 + | /* BuilderGenerator.kt:494 */.ok_or_else(||
|
435 + | /* BuilderGenerator.kt:117 */::aws_smithy_types::error::operation::BuildError::missing_field("comparison_operator", "comparison_operator was not specified but it is required when building Condition")
|
436 + | /* BuilderGenerator.kt:494 */)?
|
437 + | ,
|
438 + | /* BuilderGenerator.kt:477 */}
|
439 + | /* BuilderGenerator.kt:254 */)
|
440 + | /* BuilderGenerator.kt:253 */
|
390 441 | }
|
442 + | /* BuilderGenerator.kt:355 */
|
391 443 | }
|