1 1 | // Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
|
2 - |
|
3 - | /// <p>Represents the input of a <code>Scan</code> operation.</p>
|
2 + | /* StructureGenerator.kt:197 */
|
3 + | /// /* StructureGenerator.kt:197 */<p>Represents the input of a <code>Scan</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 ScanInput {
|
7 - | /// <p>The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</p>
|
8 + | pub /* StructureGenerator.kt:201 */ struct ScanInput {
|
9 + | /// /* StructureGenerator.kt:231 */<p>The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</p>
|
8 10 | pub table_name: ::std::option::Option<::std::string::String>,
|
9 - | /// <p>The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the <code>IndexName</code> parameter, you must also provide <code>TableName</code>.</p>
|
11 + | /// /* StructureGenerator.kt:231 */<p>The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the <code>IndexName</code> parameter, you must also provide <code>TableName</code>.</p>
|
10 12 | pub index_name: ::std::option::Option<::std::string::String>,
|
11 - | /// <p>This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html">AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
13 + | /// /* StructureGenerator.kt:231 */<p>This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html">AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
12 14 | pub attributes_to_get: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
|
13 - | /// <p>The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation to continue the operation. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Working with Queries</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
15 + | /// /* StructureGenerator.kt:231 */<p>The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation to continue the operation. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Working with Queries</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
14 16 | pub limit: ::std::option::Option<i32>,
|
15 - | /// <p>The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.</p>
|
17 + | /// /* StructureGenerator.kt:231 */<p>The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.</p>
|
16 18 | /// <ul>
|
17 19 | /// <li>
|
18 20 | /// <p><code>ALL_ATTRIBUTES</code> - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.</p></li>
|
19 21 | /// <li>
|
20 22 | /// <p><code>ALL_PROJECTED_ATTRIBUTES</code> - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying <code>ALL_ATTRIBUTES</code>.</p></li>
|
21 23 | /// <li>
|
22 24 | /// <p><code>COUNT</code> - Returns the number of matching items, rather than the matching items themselves.</p></li>
|
23 25 | /// <li>
|
24 26 | /// <p><code>SPECIFIC_ATTRIBUTES</code> - Returns only the attributes listed in <code>AttributesToGet</code>. This return value is equivalent to specifying <code>AttributesToGet</code> without specifying any value for <code>Select</code>.</p>
|
25 27 | /// <p>If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.</p>
|
26 28 | /// <p>If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.</p></li>
|
27 29 | /// </ul>
|
28 30 | /// <p>If neither <code>Select</code> nor <code>AttributesToGet</code> are specified, DynamoDB defaults to <code>ALL_ATTRIBUTES</code> when accessing a table, and <code>ALL_PROJECTED_ATTRIBUTES</code> when accessing an index. You cannot use both <code>Select</code> and <code>AttributesToGet</code> together in a single request, unless the value for <code>Select</code> is <code>SPECIFIC_ATTRIBUTES</code>. (This usage is equivalent to specifying <code>AttributesToGet</code> without any value for <code>Select</code>.)</p><note>
|
29 31 | /// <p>If you use the <code>ProjectionExpression</code> parameter, then the value for <code>Select</code> can only be <code>SPECIFIC_ATTRIBUTES</code>. Any other value for <code>Select</code> will return an error.</p>
|
30 32 | /// </note>
|
31 33 | pub select: ::std::option::Option<crate::types::Select>,
|
32 - | /// <p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html">ScanFilter</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
34 + | /// /* StructureGenerator.kt:231 */<p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html">ScanFilter</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
33 35 | pub scan_filter: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::Condition>>,
|
34 - | /// <p>This is a legacy parameter. Use <code>FilterExpression</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>
|
36 + | /// /* StructureGenerator.kt:231 */<p>This is a legacy parameter. Use <code>FilterExpression</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>
|
35 37 | pub conditional_operator: ::std::option::Option<crate::types::ConditionalOperator>,
|
36 - | /// <p>The primary key of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedKey</code> in the previous operation.</p>
|
38 + | /// /* StructureGenerator.kt:231 */<p>The primary key of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedKey</code> in the previous operation.</p>
|
37 39 | /// <p>The data type for <code>ExclusiveStartKey</code> must be String, Number or Binary. No set data types are allowed.</p>
|
38 40 | /// <p>In a parallel scan, a <code>Scan</code> request that includes <code>ExclusiveStartKey</code> must specify the same segment whose previous <code>Scan</code> returned the corresponding value of <code>LastEvaluatedKey</code>.</p>
|
39 41 | pub exclusive_start_key: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
|
40 - | /// <p>Determines the level of detail about provisioned throughput consumption that is returned in the response:</p>
|
42 + | /// /* StructureGenerator.kt:231 */<p>Determines the level of detail about provisioned throughput consumption that is returned in the response:</p>
|
41 43 | /// <ul>
|
42 44 | /// <li>
|
43 45 | /// <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>
|
44 46 | /// <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>
|
45 47 | /// <li>
|
46 48 | /// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
|
47 49 | /// <li>
|
48 50 | /// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
|
49 51 | /// </ul>
|
50 52 | pub return_consumed_capacity: ::std::option::Option<crate::types::ReturnConsumedCapacity>,
|
51 - | /// <p>For a parallel <code>Scan</code> request, <code>TotalSegments</code> represents the total number of segments into which the <code>Scan</code> operation will be divided. The value of <code>TotalSegments</code> corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a <code>TotalSegments</code> value of 4.</p>
|
53 + | /// /* StructureGenerator.kt:231 */<p>For a parallel <code>Scan</code> request, <code>TotalSegments</code> represents the total number of segments into which the <code>Scan</code> operation will be divided. The value of <code>TotalSegments</code> corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a <code>TotalSegments</code> value of 4.</p>
|
52 54 | /// <p>The value for <code>TotalSegments</code> must be greater than or equal to 1, and less than or equal to 1000000. If you specify a <code>TotalSegments</code> value of 1, the <code>Scan</code> operation will be sequential rather than parallel.</p>
|
53 55 | /// <p>If you specify <code>TotalSegments</code>, you must also specify <code>Segment</code>.</p>
|
54 56 | pub total_segments: ::std::option::Option<i32>,
|
55 - | /// <p>For a parallel <code>Scan</code> request, <code>Segment</code> identifies an individual segment to be scanned by an application worker.</p>
|
57 + | /// /* StructureGenerator.kt:231 */<p>For a parallel <code>Scan</code> request, <code>Segment</code> identifies an individual segment to be scanned by an application worker.</p>
|
56 58 | /// <p>Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a <code>Segment</code> value of 0, the second thread specifies 1, and so on.</p>
|
57 59 | /// <p>The value of <code>LastEvaluatedKey</code> returned from a parallel <code>Scan</code> request must be used as <code>ExclusiveStartKey</code> with the same segment ID in a subsequent <code>Scan</code> operation.</p>
|
58 60 | /// <p>The value for <code>Segment</code> must be greater than or equal to 0, and less than the value provided for <code>TotalSegments</code>.</p>
|
59 61 | /// <p>If you provide <code>Segment</code>, you must also provide <code>TotalSegments</code>.</p>
|
60 62 | pub segment: ::std::option::Option<i32>,
|
61 - | /// <p>A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.</p>
|
63 + | /// /* StructureGenerator.kt:231 */<p>A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.</p>
|
62 64 | /// <p>If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.</p>
|
63 65 | /// <p>For more information, 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>
|
64 66 | pub projection_expression: ::std::option::Option<::std::string::String>,
|
65 - | /// <p>A string that contains conditions that DynamoDB applies after the <code>Scan</code> operation, but before the data is returned to you. Items that do not satisfy the <code>FilterExpression</code> criteria are not returned.</p><note>
|
67 + | /// /* StructureGenerator.kt:231 */<p>A string that contains conditions that DynamoDB applies after the <code>Scan</code> operation, but before the data is returned to you. Items that do not satisfy the <code>FilterExpression</code> criteria are not returned.</p><note>
|
66 68 | /// <p>A <code>FilterExpression</code> is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.</p>
|
67 69 | /// </note>
|
68 70 | /// <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#FilteringResults">Filter Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
69 71 | pub filter_expression: ::std::option::Option<::std::string::String>,
|
70 - | /// <p>One or more substitution tokens for attribute names in an expression. The following are some use cases for using <code>ExpressionAttributeNames</code>:</p>
|
72 + | /// /* 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>
|
71 73 | /// <ul>
|
72 74 | /// <li>
|
73 75 | /// <p>To access an attribute whose name conflicts with a DynamoDB reserved word.</p></li>
|
74 76 | /// <li>
|
75 77 | /// <p>To create a placeholder for repeating occurrences of an attribute name in an expression.</p></li>
|
76 78 | /// <li>
|
77 79 | /// <p>To prevent special characters in an attribute name from being misinterpreted in an expression.</p></li>
|
78 80 | /// </ul>
|
79 81 | /// <p>Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name:</p>
|
80 82 | /// <ul>
|
81 83 | /// <li>
|
82 84 | /// <p><code>Percentile</code></p></li>
|
83 85 | /// </ul>
|
84 86 | /// <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>
|
85 87 | /// <ul>
|
86 88 | /// <li>
|
87 89 | /// <p><code>{"#P":"Percentile"}</code></p></li>
|
88 90 | /// </ul>
|
89 91 | /// <p>You could then use this substitution in an expression, as in this example:</p>
|
90 92 | /// <ul>
|
91 93 | /// <li>
|
92 94 | /// <p><code>#P = :val</code></p></li>
|
93 95 | /// </ul><note>
|
94 96 | /// <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>
|
95 97 | /// </note>
|
96 98 | /// <p>For more information on 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>
|
97 99 | pub expression_attribute_names: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
|
98 - | /// <p>One or more values that can be substituted in an expression.</p>
|
100 + | /// /* StructureGenerator.kt:231 */<p>One or more values that can be substituted in an expression.</p>
|
99 101 | /// <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>
|
100 102 | /// <p><code>Available | Backordered | Discontinued</code></p>
|
101 103 | /// <p>You would first need to specify <code>ExpressionAttributeValues</code> as follows:</p>
|
102 104 | /// <p><code>{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }</code></p>
|
103 105 | /// <p>You could then use these values in an expression, such as this:</p>
|
104 106 | /// <p><code>ProductStatus IN (:avail, :back, :disc)</code></p>
|
105 107 | /// <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>
|
106 108 | pub expression_attribute_values: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
|
107 - | /// <p>A Boolean value that determines the read consistency model during the scan:</p>
|
109 + | /// /* StructureGenerator.kt:231 */<p>A Boolean value that determines the read consistency model during the scan:</p>
|
108 110 | /// <ul>
|
109 111 | /// <li>
|
110 112 | /// <p>If <code>ConsistentRead</code> is <code>false</code>, then the data returned from <code>Scan</code> might not contain the results from other recently completed write operations (<code>PutItem</code>, <code>UpdateItem</code>, or <code>DeleteItem</code>).</p></li>
|
111 113 | /// <li>
|
112 114 | /// <p>If <code>ConsistentRead</code> is <code>true</code>, then all of the write operations that completed before the <code>Scan</code> began are guaranteed to be contained in the <code>Scan</code> response.</p></li>
|
113 115 | /// </ul>
|
114 116 | /// <p>The default setting for <code>ConsistentRead</code> is <code>false</code>.</p>
|
115 117 | /// <p>The <code>ConsistentRead</code> parameter is not supported on global secondary indexes. If you scan a global secondary index with <code>ConsistentRead</code> set to true, you will receive a <code>ValidationException</code>.</p>
|
116 118 | pub consistent_read: ::std::option::Option<bool>,
|
119 + | /* StructureGenerator.kt:201 */
|
117 120 | }
|
121 + | /* StructureGenerator.kt:135 */
|
118 122 | impl ScanInput {
|
119 - | /// <p>The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</p>
|
123 + | /// /* StructureGenerator.kt:231 */<p>The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</p>
|
124 + | /* StructureGenerator.kt:166 */
|
120 125 | pub fn table_name(&self) -> ::std::option::Option<&str> {
|
126 + | /* StructureGenerator.kt:169 */
|
121 127 | self.table_name.as_deref()
|
128 + | /* StructureGenerator.kt:166 */
|
122 129 | }
|
123 - | /// <p>The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the <code>IndexName</code> parameter, you must also provide <code>TableName</code>.</p>
|
130 + | /// /* StructureGenerator.kt:231 */<p>The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the <code>IndexName</code> parameter, you must also provide <code>TableName</code>.</p>
|
131 + | /* StructureGenerator.kt:166 */
|
124 132 | pub fn index_name(&self) -> ::std::option::Option<&str> {
|
133 + | /* StructureGenerator.kt:169 */
|
125 134 | self.index_name.as_deref()
|
135 + | /* StructureGenerator.kt:166 */
|
126 136 | }
|
127 - | /// <p>This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html">AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
128 - | ///
|
129 - | /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.attributes_to_get.is_none()`.
|
137 + | /// /* StructureGenerator.kt:231 */<p>This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html">AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
138 + | /// /* StructureGenerator.kt:162 */
|
139 + | /// /* 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 `.attributes_to_get.is_none()`.
|
140 + | /* StructureGenerator.kt:166 */
|
130 141 | pub fn attributes_to_get(&self) -> &[::std::string::String] {
|
131 - | self.attributes_to_get.as_deref().unwrap_or_default()
|
132 - | }
|
133 - | /// <p>The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation to continue the operation. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Working with Queries</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
142 + | /* StructureGenerator.kt:169 */
|
143 + | self.attributes_to_get
|
144 + | .as_deref()
|
145 + | /* StructureGenerator.kt:175 */
|
146 + | .unwrap_or_default()
|
147 + | /* StructureGenerator.kt:166 */
|
148 + | }
|
149 + | /// /* StructureGenerator.kt:231 */<p>The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation to continue the operation. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Working with Queries</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
150 + | /* StructureGenerator.kt:166 */
|
134 151 | pub fn limit(&self) -> ::std::option::Option<i32> {
|
152 + | /* StructureGenerator.kt:168 */
|
135 153 | self.limit
|
154 + | /* StructureGenerator.kt:166 */
|
136 155 | }
|
137 - | /// <p>The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.</p>
|
156 + | /// /* StructureGenerator.kt:231 */<p>The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.</p>
|
138 157 | /// <ul>
|
139 158 | /// <li>
|
140 159 | /// <p><code>ALL_ATTRIBUTES</code> - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.</p></li>
|
141 160 | /// <li>
|
142 161 | /// <p><code>ALL_PROJECTED_ATTRIBUTES</code> - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying <code>ALL_ATTRIBUTES</code>.</p></li>
|
143 162 | /// <li>
|
144 163 | /// <p><code>COUNT</code> - Returns the number of matching items, rather than the matching items themselves.</p></li>
|
145 164 | /// <li>
|
146 165 | /// <p><code>SPECIFIC_ATTRIBUTES</code> - Returns only the attributes listed in <code>AttributesToGet</code>. This return value is equivalent to specifying <code>AttributesToGet</code> without specifying any value for <code>Select</code>.</p>
|
147 166 | /// <p>If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.</p>
|
148 167 | /// <p>If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.</p></li>
|
149 168 | /// </ul>
|
150 169 | /// <p>If neither <code>Select</code> nor <code>AttributesToGet</code> are specified, DynamoDB defaults to <code>ALL_ATTRIBUTES</code> when accessing a table, and <code>ALL_PROJECTED_ATTRIBUTES</code> when accessing an index. You cannot use both <code>Select</code> and <code>AttributesToGet</code> together in a single request, unless the value for <code>Select</code> is <code>SPECIFIC_ATTRIBUTES</code>. (This usage is equivalent to specifying <code>AttributesToGet</code> without any value for <code>Select</code>.)</p><note>
|
151 170 | /// <p>If you use the <code>ProjectionExpression</code> parameter, then the value for <code>Select</code> can only be <code>SPECIFIC_ATTRIBUTES</code>. Any other value for <code>Select</code> will return an error.</p>
|
152 171 | /// </note>
|
172 + | /* StructureGenerator.kt:166 */
|
153 173 | pub fn select(&self) -> ::std::option::Option<&crate::types::Select> {
|
174 + | /* StructureGenerator.kt:170 */
|
154 175 | self.select.as_ref()
|
176 + | /* StructureGenerator.kt:166 */
|
155 177 | }
|
156 - | /// <p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html">ScanFilter</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
178 + | /// /* StructureGenerator.kt:231 */<p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html">ScanFilter</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
179 + | /* StructureGenerator.kt:166 */
|
157 180 | pub fn scan_filter(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, crate::types::Condition>> {
|
181 + | /* StructureGenerator.kt:170 */
|
158 182 | self.scan_filter.as_ref()
|
183 + | /* StructureGenerator.kt:166 */
|
159 184 | }
|
160 - | /// <p>This is a legacy parameter. Use <code>FilterExpression</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>
|
185 + | /// /* StructureGenerator.kt:231 */<p>This is a legacy parameter. Use <code>FilterExpression</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>
|
186 + | /* StructureGenerator.kt:166 */
|
161 187 | pub fn conditional_operator(&self) -> ::std::option::Option<&crate::types::ConditionalOperator> {
|
188 + | /* StructureGenerator.kt:170 */
|
162 189 | self.conditional_operator.as_ref()
|
190 + | /* StructureGenerator.kt:166 */
|
163 191 | }
|
164 - | /// <p>The primary key of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedKey</code> in the previous operation.</p>
|
192 + | /// /* StructureGenerator.kt:231 */<p>The primary key of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedKey</code> in the previous operation.</p>
|
165 193 | /// <p>The data type for <code>ExclusiveStartKey</code> must be String, Number or Binary. No set data types are allowed.</p>
|
166 194 | /// <p>In a parallel scan, a <code>Scan</code> request that includes <code>ExclusiveStartKey</code> must specify the same segment whose previous <code>Scan</code> returned the corresponding value of <code>LastEvaluatedKey</code>.</p>
|
195 + | /* StructureGenerator.kt:166 */
|
167 196 | pub fn exclusive_start_key(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>> {
|
197 + | /* StructureGenerator.kt:170 */
|
168 198 | self.exclusive_start_key.as_ref()
|
199 + | /* StructureGenerator.kt:166 */
|
169 200 | }
|
170 - | /// <p>Determines the level of detail about provisioned throughput consumption that is returned in the response:</p>
|
201 + | /// /* StructureGenerator.kt:231 */<p>Determines the level of detail about provisioned throughput consumption that is returned in the response:</p>
|
171 202 | /// <ul>
|
172 203 | /// <li>
|
173 204 | /// <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>
|
174 205 | /// <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>
|
175 206 | /// <li>
|
176 207 | /// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
|
177 208 | /// <li>
|
178 209 | /// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
|
179 210 | /// </ul>
|
211 + | /* StructureGenerator.kt:166 */
|
180 212 | pub fn return_consumed_capacity(&self) -> ::std::option::Option<&crate::types::ReturnConsumedCapacity> {
|
213 + | /* StructureGenerator.kt:170 */
|
181 214 | self.return_consumed_capacity.as_ref()
|
215 + | /* StructureGenerator.kt:166 */
|
182 216 | }
|
183 - | /// <p>For a parallel <code>Scan</code> request, <code>TotalSegments</code> represents the total number of segments into which the <code>Scan</code> operation will be divided. The value of <code>TotalSegments</code> corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a <code>TotalSegments</code> value of 4.</p>
|
217 + | /// /* StructureGenerator.kt:231 */<p>For a parallel <code>Scan</code> request, <code>TotalSegments</code> represents the total number of segments into which the <code>Scan</code> operation will be divided. The value of <code>TotalSegments</code> corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a <code>TotalSegments</code> value of 4.</p>
|
184 218 | /// <p>The value for <code>TotalSegments</code> must be greater than or equal to 1, and less than or equal to 1000000. If you specify a <code>TotalSegments</code> value of 1, the <code>Scan</code> operation will be sequential rather than parallel.</p>
|
185 219 | /// <p>If you specify <code>TotalSegments</code>, you must also specify <code>Segment</code>.</p>
|
220 + | /* StructureGenerator.kt:166 */
|
186 221 | pub fn total_segments(&self) -> ::std::option::Option<i32> {
|
222 + | /* StructureGenerator.kt:168 */
|
187 223 | self.total_segments
|
224 + | /* StructureGenerator.kt:166 */
|
188 225 | }
|
189 - | /// <p>For a parallel <code>Scan</code> request, <code>Segment</code> identifies an individual segment to be scanned by an application worker.</p>
|
226 + | /// /* StructureGenerator.kt:231 */<p>For a parallel <code>Scan</code> request, <code>Segment</code> identifies an individual segment to be scanned by an application worker.</p>
|
190 227 | /// <p>Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a <code>Segment</code> value of 0, the second thread specifies 1, and so on.</p>
|
191 228 | /// <p>The value of <code>LastEvaluatedKey</code> returned from a parallel <code>Scan</code> request must be used as <code>ExclusiveStartKey</code> with the same segment ID in a subsequent <code>Scan</code> operation.</p>
|
192 229 | /// <p>The value for <code>Segment</code> must be greater than or equal to 0, and less than the value provided for <code>TotalSegments</code>.</p>
|
193 230 | /// <p>If you provide <code>Segment</code>, you must also provide <code>TotalSegments</code>.</p>
|
231 + | /* StructureGenerator.kt:166 */
|
194 232 | pub fn segment(&self) -> ::std::option::Option<i32> {
|
233 + | /* StructureGenerator.kt:168 */
|
195 234 | self.segment
|
235 + | /* StructureGenerator.kt:166 */
|
196 236 | }
|
197 - | /// <p>A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.</p>
|
237 + | /// /* StructureGenerator.kt:231 */<p>A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.</p>
|
198 238 | /// <p>If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.</p>
|
199 239 | /// <p>For more information, 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>
|
240 + | /* StructureGenerator.kt:166 */
|
200 241 | pub fn projection_expression(&self) -> ::std::option::Option<&str> {
|
242 + | /* StructureGenerator.kt:169 */
|
201 243 | self.projection_expression.as_deref()
|
244 + | /* StructureGenerator.kt:166 */
|
202 245 | }
|
203 - | /// <p>A string that contains conditions that DynamoDB applies after the <code>Scan</code> operation, but before the data is returned to you. Items that do not satisfy the <code>FilterExpression</code> criteria are not returned.</p><note>
|
246 + | /// /* StructureGenerator.kt:231 */<p>A string that contains conditions that DynamoDB applies after the <code>Scan</code> operation, but before the data is returned to you. Items that do not satisfy the <code>FilterExpression</code> criteria are not returned.</p><note>
|
204 247 | /// <p>A <code>FilterExpression</code> is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.</p>
|
205 248 | /// </note>
|
206 249 | /// <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#FilteringResults">Filter Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
250 + | /* StructureGenerator.kt:166 */
|
207 251 | pub fn filter_expression(&self) -> ::std::option::Option<&str> {
|
252 + | /* StructureGenerator.kt:169 */
|
208 253 | self.filter_expression.as_deref()
|
254 + | /* StructureGenerator.kt:166 */
|
209 255 | }
|
210 - | /// <p>One or more substitution tokens for attribute names in an expression. The following are some use cases for using <code>ExpressionAttributeNames</code>:</p>
|
256 + | /// /* 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>
|
211 257 | /// <ul>
|
212 258 | /// <li>
|
213 259 | /// <p>To access an attribute whose name conflicts with a DynamoDB reserved word.</p></li>
|
214 260 | /// <li>
|
215 261 | /// <p>To create a placeholder for repeating occurrences of an attribute name in an expression.</p></li>
|
216 262 | /// <li>
|
217 263 | /// <p>To prevent special characters in an attribute name from being misinterpreted in an expression.</p></li>
|
218 264 | /// </ul>
|
219 265 | /// <p>Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name:</p>
|
220 266 | /// <ul>
|
221 267 | /// <li>
|
222 268 | /// <p><code>Percentile</code></p></li>
|
223 269 | /// </ul>
|
224 270 | /// <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>
|
225 271 | /// <ul>
|
226 272 | /// <li>
|
227 273 | /// <p><code>{"#P":"Percentile"}</code></p></li>
|
228 274 | /// </ul>
|
229 275 | /// <p>You could then use this substitution in an expression, as in this example:</p>
|
230 276 | /// <ul>
|
231 277 | /// <li>
|
232 278 | /// <p><code>#P = :val</code></p></li>
|
233 279 | /// </ul><note>
|
234 280 | /// <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>
|
235 281 | /// </note>
|
236 282 | /// <p>For more information on 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>
|
283 + | /* StructureGenerator.kt:166 */
|
237 284 | pub fn expression_attribute_names(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
|
285 + | /* StructureGenerator.kt:170 */
|
238 286 | self.expression_attribute_names.as_ref()
|
287 + | /* StructureGenerator.kt:166 */
|
239 288 | }
|
240 - | /// <p>One or more values that can be substituted in an expression.</p>
|
289 + | /// /* StructureGenerator.kt:231 */<p>One or more values that can be substituted in an expression.</p>
|
241 290 | /// <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>
|
242 291 | /// <p><code>Available | Backordered | Discontinued</code></p>
|
243 292 | /// <p>You would first need to specify <code>ExpressionAttributeValues</code> as follows:</p>
|
244 293 | /// <p><code>{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }</code></p>
|
245 294 | /// <p>You could then use these values in an expression, such as this:</p>
|
246 295 | /// <p><code>ProductStatus IN (:avail, :back, :disc)</code></p>
|
247 296 | /// <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>
|
297 + | /* StructureGenerator.kt:166 */
|
248 298 | pub fn expression_attribute_values(
|
249 299 | &self,
|
250 300 | ) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>> {
|
301 + | /* StructureGenerator.kt:170 */
|
251 302 | self.expression_attribute_values.as_ref()
|
303 + | /* StructureGenerator.kt:166 */
|
252 304 | }
|
253 - | /// <p>A Boolean value that determines the read consistency model during the scan:</p>
|
305 + | /// /* StructureGenerator.kt:231 */<p>A Boolean value that determines the read consistency model during the scan:</p>
|
254 306 | /// <ul>
|
255 307 | /// <li>
|
256 308 | /// <p>If <code>ConsistentRead</code> is <code>false</code>, then the data returned from <code>Scan</code> might not contain the results from other recently completed write operations (<code>PutItem</code>, <code>UpdateItem</code>, or <code>DeleteItem</code>).</p></li>
|
257 309 | /// <li>
|
258 310 | /// <p>If <code>ConsistentRead</code> is <code>true</code>, then all of the write operations that completed before the <code>Scan</code> began are guaranteed to be contained in the <code>Scan</code> response.</p></li>
|
259 311 | /// </ul>
|
260 312 | /// <p>The default setting for <code>ConsistentRead</code> is <code>false</code>.</p>
|
261 313 | /// <p>The <code>ConsistentRead</code> parameter is not supported on global secondary indexes. If you scan a global secondary index with <code>ConsistentRead</code> set to true, you will receive a <code>ValidationException</code>.</p>
|
314 + | /* StructureGenerator.kt:166 */
|
262 315 | pub fn consistent_read(&self) -> ::std::option::Option<bool> {
|
316 + | /* StructureGenerator.kt:168 */
|
263 317 | self.consistent_read
|
318 + | /* StructureGenerator.kt:166 */
|
264 319 | }
|
320 + | /* StructureGenerator.kt:135 */
|
265 321 | }
|
322 + | /* ClientCodegenVisitor.kt:237 */
|
266 323 | impl ScanInput {
|
267 - | /// Creates a new builder-style object to manufacture [`ScanInput`](crate::operation::scan::ScanInput).
|
324 + | /// /* BuilderGenerator.kt:173 */Creates a new builder-style object to manufacture [`ScanInput`](crate::operation::scan::ScanInput).
|
325 + | /* BuilderGenerator.kt:175 */
|
268 326 | pub fn builder() -> crate::operation::scan::builders::ScanInputBuilder {
|
327 + | /* BuilderGenerator.kt:176 */
|
269 328 | crate::operation::scan::builders::ScanInputBuilder::default()
|
329 + | /* BuilderGenerator.kt:175 */
|
270 330 | }
|
331 + | /* ClientCodegenVisitor.kt:237 */
|
271 332 | }
|
272 333 |
|
273 - | /// A builder for [`ScanInput`](crate::operation::scan::ScanInput).
|
334 + | /// /* BuilderGenerator.kt:342 */A builder for [`ScanInput`](crate::operation::scan::ScanInput).
|
335 + | /* RustType.kt:516 */
|
274 336 | #[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
|
337 + | /* RustType.kt:516 */
|
275 338 | #[non_exhaustive]
|
339 + | /* BuilderGenerator.kt:345 */
|
276 340 | pub struct ScanInputBuilder {
|
277 - | pub(crate) table_name: ::std::option::Option<::std::string::String>,
|
278 - | pub(crate) index_name: ::std::option::Option<::std::string::String>,
|
279 - | pub(crate) attributes_to_get: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
|
280 - | pub(crate) limit: ::std::option::Option<i32>,
|
281 - | pub(crate) select: ::std::option::Option<crate::types::Select>,
|
341 + | /* BuilderGenerator.kt:275 */ pub(crate) table_name: ::std::option::Option<::std::string::String>,
|
342 + | /* BuilderGenerator.kt:275 */ pub(crate) index_name: ::std::option::Option<::std::string::String>,
|
343 + | /* BuilderGenerator.kt:275 */ pub(crate) attributes_to_get: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
|
344 + | /* BuilderGenerator.kt:275 */ pub(crate) limit: ::std::option::Option<i32>,
|
345 + | /* BuilderGenerator.kt:275 */ pub(crate) select: ::std::option::Option<crate::types::Select>,
|
346 + | /* BuilderGenerator.kt:275 */
|
282 347 | pub(crate) scan_filter: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::Condition>>,
|
283 - | pub(crate) conditional_operator: ::std::option::Option<crate::types::ConditionalOperator>,
|
348 + | /* BuilderGenerator.kt:275 */ pub(crate) conditional_operator: ::std::option::Option<crate::types::ConditionalOperator>,
|
349 + | /* BuilderGenerator.kt:275 */
|
284 350 | pub(crate) exclusive_start_key: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
|
285 - | pub(crate) return_consumed_capacity: ::std::option::Option<crate::types::ReturnConsumedCapacity>,
|
286 - | pub(crate) total_segments: ::std::option::Option<i32>,
|
287 - | pub(crate) segment: ::std::option::Option<i32>,
|
288 - | pub(crate) projection_expression: ::std::option::Option<::std::string::String>,
|
289 - | pub(crate) filter_expression: ::std::option::Option<::std::string::String>,
|
351 + | /* BuilderGenerator.kt:275 */ pub(crate) return_consumed_capacity: ::std::option::Option<crate::types::ReturnConsumedCapacity>,
|
352 + | /* BuilderGenerator.kt:275 */ pub(crate) total_segments: ::std::option::Option<i32>,
|
353 + | /* BuilderGenerator.kt:275 */ pub(crate) segment: ::std::option::Option<i32>,
|
354 + | /* BuilderGenerator.kt:275 */ pub(crate) projection_expression: ::std::option::Option<::std::string::String>,
|
355 + | /* BuilderGenerator.kt:275 */ pub(crate) filter_expression: ::std::option::Option<::std::string::String>,
|
356 + | /* BuilderGenerator.kt:275 */
|
290 357 | pub(crate) expression_attribute_names: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
|
358 + | /* BuilderGenerator.kt:275 */
|
291 359 | pub(crate) expression_attribute_values: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
|
292 - | pub(crate) consistent_read: ::std::option::Option<bool>,
|
360 + | /* BuilderGenerator.kt:275 */ pub(crate) consistent_read: ::std::option::Option<bool>,
|
361 + | /* BuilderGenerator.kt:345 */
|
293 362 | }
|
363 + | /* BuilderGenerator.kt:355 */
|
294 364 | impl ScanInputBuilder {
|
295 - | /// <p>The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</p>
|
296 - | /// This field is required.
|
365 + | /// /* BuilderGenerator.kt:286 */<p>The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</p>
|
366 + | /// /* BuilderGenerator.kt:288 */This field is required.
|
367 + | /* BuilderGenerator.kt:291 */
|
297 368 | pub fn table_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
|
369 + | /* BuilderGenerator.kt:292 */
|
298 370 | self.table_name = ::std::option::Option::Some(input.into());
|
371 + | /* BuilderGenerator.kt:293 */
|
299 372 | self
|
373 + | /* BuilderGenerator.kt:291 */
|
300 374 | }
|
301 - | /// <p>The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</p>
|
375 + | /// /* BuilderGenerator.kt:312 */<p>The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</p>
|
376 + | /* BuilderGenerator.kt:314 */
|
302 377 | pub fn set_table_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
|
378 + | /* BuilderGenerator.kt:315 */
|
303 379 | self.table_name = input;
|
304 380 | self
|
381 + | /* BuilderGenerator.kt:314 */
|
305 382 | }
|
306 - | /// <p>The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</p>
|
383 + | /// /* BuilderGenerator.kt:334 */<p>The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</p>
|
384 + | /* BuilderGenerator.kt:336 */
|
307 385 | pub fn get_table_name(&self) -> &::std::option::Option<::std::string::String> {
|
386 + | /* BuilderGenerator.kt:337 */
|
308 387 | &self.table_name
|
388 + | /* BuilderGenerator.kt:336 */
|
309 389 | }
|
310 - | /// <p>The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the <code>IndexName</code> parameter, you must also provide <code>TableName</code>.</p>
|
390 + | /// /* BuilderGenerator.kt:286 */<p>The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the <code>IndexName</code> parameter, you must also provide <code>TableName</code>.</p>
|
391 + | /* BuilderGenerator.kt:291 */
|
311 392 | pub fn index_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
|
393 + | /* BuilderGenerator.kt:292 */
|
312 394 | self.index_name = ::std::option::Option::Some(input.into());
|
395 + | /* BuilderGenerator.kt:293 */
|
313 396 | self
|
397 + | /* BuilderGenerator.kt:291 */
|
314 398 | }
|
315 - | /// <p>The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the <code>IndexName</code> parameter, you must also provide <code>TableName</code>.</p>
|
399 + | /// /* BuilderGenerator.kt:312 */<p>The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the <code>IndexName</code> parameter, you must also provide <code>TableName</code>.</p>
|
400 + | /* BuilderGenerator.kt:314 */
|
316 401 | pub fn set_index_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
|
402 + | /* BuilderGenerator.kt:315 */
|
317 403 | self.index_name = input;
|
318 404 | self
|
405 + | /* BuilderGenerator.kt:314 */
|
319 406 | }
|
320 - | /// <p>The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the <code>IndexName</code> parameter, you must also provide <code>TableName</code>.</p>
|
407 + | /// /* BuilderGenerator.kt:334 */<p>The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the <code>IndexName</code> parameter, you must also provide <code>TableName</code>.</p>
|
408 + | /* BuilderGenerator.kt:336 */
|
321 409 | pub fn get_index_name(&self) -> &::std::option::Option<::std::string::String> {
|
410 + | /* BuilderGenerator.kt:337 */
|
322 411 | &self.index_name
|
412 + | /* BuilderGenerator.kt:336 */
|
323 413 | }
|
324 - | /// Appends an item to `attributes_to_get`.
|
414 + | /// /* BuilderGenerator.kt:410 */Appends an item to `attributes_to_get`.
|
415 + | /* BuilderGenerator.kt:411 */
|
325 416 | ///
|
326 - | /// To override the contents of this collection use [`set_attributes_to_get`](Self::set_attributes_to_get).
|
417 + | /// /* BuilderGenerator.kt:412 */To override the contents of this collection use [`set_attributes_to_get`](Self::set_attributes_to_get).
|
418 + | /* BuilderGenerator.kt:413 */
|
327 419 | ///
|
328 - | /// <p>This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html">AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
420 + | /// /* BuilderGenerator.kt:414 */<p>This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html">AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
421 + | /* BuilderGenerator.kt:418 */
|
329 422 | pub fn attributes_to_get(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
|
423 + | /* BuilderGenerator.kt:419 */
|
330 424 | let mut v = self.attributes_to_get.unwrap_or_default();
|
331 425 | v.push(input.into());
|
332 426 | self.attributes_to_get = ::std::option::Option::Some(v);
|
333 427 | self
|
428 + | /* BuilderGenerator.kt:418 */
|
334 429 | }
|
335 - | /// <p>This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html">AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
430 + | /// /* BuilderGenerator.kt:312 */<p>This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html">AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
431 + | /* BuilderGenerator.kt:314 */
|
336 432 | pub fn set_attributes_to_get(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
|
433 + | /* BuilderGenerator.kt:315 */
|
337 434 | self.attributes_to_get = input;
|
338 435 | self
|
436 + | /* BuilderGenerator.kt:314 */
|
339 437 | }
|
340 - | /// <p>This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html">AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
438 + | /// /* BuilderGenerator.kt:334 */<p>This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html">AttributesToGet</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
439 + | /* BuilderGenerator.kt:336 */
|
341 440 | pub fn get_attributes_to_get(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
|
441 + | /* BuilderGenerator.kt:337 */
|
342 442 | &self.attributes_to_get
|
443 + | /* BuilderGenerator.kt:336 */
|
343 444 | }
|
344 - | /// <p>The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation to continue the operation. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Working with Queries</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
445 + | /// /* BuilderGenerator.kt:286 */<p>The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation to continue the operation. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Working with Queries</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
446 + | /* BuilderGenerator.kt:291 */
|
345 447 | pub fn limit(mut self, input: i32) -> Self {
|
448 + | /* BuilderGenerator.kt:292 */
|
346 449 | self.limit = ::std::option::Option::Some(input);
|
450 + | /* BuilderGenerator.kt:293 */
|
347 451 | self
|
452 + | /* BuilderGenerator.kt:291 */
|
348 453 | }
|
349 - | /// <p>The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation to continue the operation. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Working with Queries</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
454 + | /// /* BuilderGenerator.kt:312 */<p>The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation to continue the operation. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Working with Queries</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
455 + | /* BuilderGenerator.kt:314 */
|
350 456 | pub fn set_limit(mut self, input: ::std::option::Option<i32>) -> Self {
|
457 + | /* BuilderGenerator.kt:315 */
|
351 458 | self.limit = input;
|
352 459 | self
|
460 + | /* BuilderGenerator.kt:314 */
|
353 461 | }
|
354 - | /// <p>The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation to continue the operation. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Working with Queries</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
462 + | /// /* BuilderGenerator.kt:334 */<p>The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation to continue the operation. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Working with Queries</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
463 + | /* BuilderGenerator.kt:336 */
|
355 464 | pub fn get_limit(&self) -> &::std::option::Option<i32> {
|
465 + | /* BuilderGenerator.kt:337 */
|
356 466 | &self.limit
|
467 + | /* BuilderGenerator.kt:336 */
|
357 468 | }
|
358 - | /// <p>The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.</p>
|
469 + | /// /* BuilderGenerator.kt:286 */<p>The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.</p>
|
359 470 | /// <ul>
|
360 471 | /// <li>
|
361 472 | /// <p><code>ALL_ATTRIBUTES</code> - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.</p></li>
|
362 473 | /// <li>
|
363 474 | /// <p><code>ALL_PROJECTED_ATTRIBUTES</code> - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying <code>ALL_ATTRIBUTES</code>.</p></li>
|
364 475 | /// <li>
|
365 476 | /// <p><code>COUNT</code> - Returns the number of matching items, rather than the matching items themselves.</p></li>
|
366 477 | /// <li>
|
367 478 | /// <p><code>SPECIFIC_ATTRIBUTES</code> - Returns only the attributes listed in <code>AttributesToGet</code>. This return value is equivalent to specifying <code>AttributesToGet</code> without specifying any value for <code>Select</code>.</p>
|
368 479 | /// <p>If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.</p>
|
369 480 | /// <p>If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.</p></li>
|
370 481 | /// </ul>
|
371 482 | /// <p>If neither <code>Select</code> nor <code>AttributesToGet</code> are specified, DynamoDB defaults to <code>ALL_ATTRIBUTES</code> when accessing a table, and <code>ALL_PROJECTED_ATTRIBUTES</code> when accessing an index. You cannot use both <code>Select</code> and <code>AttributesToGet</code> together in a single request, unless the value for <code>Select</code> is <code>SPECIFIC_ATTRIBUTES</code>. (This usage is equivalent to specifying <code>AttributesToGet</code> without any value for <code>Select</code>.)</p><note>
|
372 483 | /// <p>If you use the <code>ProjectionExpression</code> parameter, then the value for <code>Select</code> can only be <code>SPECIFIC_ATTRIBUTES</code>. Any other value for <code>Select</code> will return an error.</p>
|
373 484 | /// </note>
|
485 + | /* BuilderGenerator.kt:291 */
|
374 486 | pub fn select(mut self, input: crate::types::Select) -> Self {
|
487 + | /* BuilderGenerator.kt:292 */
|
375 488 | self.select = ::std::option::Option::Some(input);
|
489 + | /* BuilderGenerator.kt:293 */
|
376 490 | self
|
491 + | /* BuilderGenerator.kt:291 */
|
377 492 | }
|
378 - | /// <p>The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.</p>
|
493 + | /// /* BuilderGenerator.kt:312 */<p>The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.</p>
|
379 494 | /// <ul>
|
380 495 | /// <li>
|
381 496 | /// <p><code>ALL_ATTRIBUTES</code> - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.</p></li>
|
382 497 | /// <li>
|
383 498 | /// <p><code>ALL_PROJECTED_ATTRIBUTES</code> - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying <code>ALL_ATTRIBUTES</code>.</p></li>
|
384 499 | /// <li>
|
385 500 | /// <p><code>COUNT</code> - Returns the number of matching items, rather than the matching items themselves.</p></li>
|
386 501 | /// <li>
|
387 502 | /// <p><code>SPECIFIC_ATTRIBUTES</code> - Returns only the attributes listed in <code>AttributesToGet</code>. This return value is equivalent to specifying <code>AttributesToGet</code> without specifying any value for <code>Select</code>.</p>
|
388 503 | /// <p>If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.</p>
|
389 504 | /// <p>If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.</p></li>
|
390 505 | /// </ul>
|
391 506 | /// <p>If neither <code>Select</code> nor <code>AttributesToGet</code> are specified, DynamoDB defaults to <code>ALL_ATTRIBUTES</code> when accessing a table, and <code>ALL_PROJECTED_ATTRIBUTES</code> when accessing an index. You cannot use both <code>Select</code> and <code>AttributesToGet</code> together in a single request, unless the value for <code>Select</code> is <code>SPECIFIC_ATTRIBUTES</code>. (This usage is equivalent to specifying <code>AttributesToGet</code> without any value for <code>Select</code>.)</p><note>
|
392 507 | /// <p>If you use the <code>ProjectionExpression</code> parameter, then the value for <code>Select</code> can only be <code>SPECIFIC_ATTRIBUTES</code>. Any other value for <code>Select</code> will return an error.</p>
|
393 508 | /// </note>
|
509 + | /* BuilderGenerator.kt:314 */
|
394 510 | pub fn set_select(mut self, input: ::std::option::Option<crate::types::Select>) -> Self {
|
511 + | /* BuilderGenerator.kt:315 */
|
395 512 | self.select = input;
|
396 513 | self
|
514 + | /* BuilderGenerator.kt:314 */
|
397 515 | }
|
398 - | /// <p>The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.</p>
|
516 + | /// /* BuilderGenerator.kt:334 */<p>The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.</p>
|
399 517 | /// <ul>
|
400 518 | /// <li>
|
401 519 | /// <p><code>ALL_ATTRIBUTES</code> - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.</p></li>
|
402 520 | /// <li>
|
403 521 | /// <p><code>ALL_PROJECTED_ATTRIBUTES</code> - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying <code>ALL_ATTRIBUTES</code>.</p></li>
|
404 522 | /// <li>
|
405 523 | /// <p><code>COUNT</code> - Returns the number of matching items, rather than the matching items themselves.</p></li>
|
406 524 | /// <li>
|
407 525 | /// <p><code>SPECIFIC_ATTRIBUTES</code> - Returns only the attributes listed in <code>AttributesToGet</code>. This return value is equivalent to specifying <code>AttributesToGet</code> without specifying any value for <code>Select</code>.</p>
|
408 526 | /// <p>If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.</p>
|
409 527 | /// <p>If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.</p></li>
|
410 528 | /// </ul>
|
411 529 | /// <p>If neither <code>Select</code> nor <code>AttributesToGet</code> are specified, DynamoDB defaults to <code>ALL_ATTRIBUTES</code> when accessing a table, and <code>ALL_PROJECTED_ATTRIBUTES</code> when accessing an index. You cannot use both <code>Select</code> and <code>AttributesToGet</code> together in a single request, unless the value for <code>Select</code> is <code>SPECIFIC_ATTRIBUTES</code>. (This usage is equivalent to specifying <code>AttributesToGet</code> without any value for <code>Select</code>.)</p><note>
|
412 530 | /// <p>If you use the <code>ProjectionExpression</code> parameter, then the value for <code>Select</code> can only be <code>SPECIFIC_ATTRIBUTES</code>. Any other value for <code>Select</code> will return an error.</p>
|
413 531 | /// </note>
|
532 + | /* BuilderGenerator.kt:336 */
|
414 533 | pub fn get_select(&self) -> &::std::option::Option<crate::types::Select> {
|
534 + | /* BuilderGenerator.kt:337 */
|
415 535 | &self.select
|
536 + | /* BuilderGenerator.kt:336 */
|
416 537 | }
|
417 - | /// Adds a key-value pair to `scan_filter`.
|
538 + | /// /* BuilderGenerator.kt:436 */Adds a key-value pair to `scan_filter`.
|
539 + | /* BuilderGenerator.kt:437 */
|
418 540 | ///
|
419 - | /// To override the contents of this collection use [`set_scan_filter`](Self::set_scan_filter).
|
541 + | /// /* BuilderGenerator.kt:438 */To override the contents of this collection use [`set_scan_filter`](Self::set_scan_filter).
|
542 + | /* BuilderGenerator.kt:439 */
|
420 543 | ///
|
421 - | /// <p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html">ScanFilter</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
544 + | /// /* BuilderGenerator.kt:440 */<p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html">ScanFilter</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
545 + | /* BuilderGenerator.kt:445 */
|
422 546 | pub fn scan_filter(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::Condition) -> Self {
|
547 + | /* BuilderGenerator.kt:448 */
|
423 548 | let mut hash_map = self.scan_filter.unwrap_or_default();
|
424 549 | hash_map.insert(k.into(), v);
|
425 550 | self.scan_filter = ::std::option::Option::Some(hash_map);
|
426 551 | self
|
552 + | /* BuilderGenerator.kt:445 */
|
427 553 | }
|
428 - | /// <p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html">ScanFilter</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
554 + | /// /* BuilderGenerator.kt:312 */<p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html">ScanFilter</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
555 + | /* BuilderGenerator.kt:314 */
|
429 556 | pub fn set_scan_filter(
|
430 557 | mut self,
|
431 558 | input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::Condition>>,
|
432 559 | ) -> Self {
|
560 + | /* BuilderGenerator.kt:315 */
|
433 561 | self.scan_filter = input;
|
434 562 | self
|
563 + | /* BuilderGenerator.kt:314 */
|
435 564 | }
|
436 - | /// <p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html">ScanFilter</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
565 + | /// /* BuilderGenerator.kt:334 */<p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html">ScanFilter</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
566 + | /* BuilderGenerator.kt:336 */
|
437 567 | pub fn get_scan_filter(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::Condition>> {
|
568 + | /* BuilderGenerator.kt:337 */
|
438 569 | &self.scan_filter
|
570 + | /* BuilderGenerator.kt:336 */
|
439 571 | }
|
440 - | /// <p>This is a legacy parameter. Use <code>FilterExpression</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>
|
572 + | /// /* BuilderGenerator.kt:286 */<p>This is a legacy parameter. Use <code>FilterExpression</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>
|
573 + | /* BuilderGenerator.kt:291 */
|
441 574 | pub fn conditional_operator(mut self, input: crate::types::ConditionalOperator) -> Self {
|
575 + | /* BuilderGenerator.kt:292 */
|
442 576 | self.conditional_operator = ::std::option::Option::Some(input);
|
577 + | /* BuilderGenerator.kt:293 */
|
443 578 | self
|
579 + | /* BuilderGenerator.kt:291 */
|
444 580 | }
|
445 - | /// <p>This is a legacy parameter. Use <code>FilterExpression</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>
|
581 + | /// /* BuilderGenerator.kt:312 */<p>This is a legacy parameter. Use <code>FilterExpression</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>
|
582 + | /* BuilderGenerator.kt:314 */
|
446 583 | pub fn set_conditional_operator(mut self, input: ::std::option::Option<crate::types::ConditionalOperator>) -> Self {
|
584 + | /* BuilderGenerator.kt:315 */
|
447 585 | self.conditional_operator = input;
|
448 586 | self
|
587 + | /* BuilderGenerator.kt:314 */
|
449 588 | }
|
450 - | /// <p>This is a legacy parameter. Use <code>FilterExpression</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>
|
589 + | /// /* BuilderGenerator.kt:334 */<p>This is a legacy parameter. Use <code>FilterExpression</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>
|
590 + | /* BuilderGenerator.kt:336 */
|
451 591 | pub fn get_conditional_operator(&self) -> &::std::option::Option<crate::types::ConditionalOperator> {
|
592 + | /* BuilderGenerator.kt:337 */
|
452 593 | &self.conditional_operator
|
594 + | /* BuilderGenerator.kt:336 */
|
453 595 | }
|
454 - | /// Adds a key-value pair to `exclusive_start_key`.
|
596 + | /// /* BuilderGenerator.kt:436 */Adds a key-value pair to `exclusive_start_key`.
|
597 + | /* BuilderGenerator.kt:437 */
|
455 598 | ///
|
456 - | /// To override the contents of this collection use [`set_exclusive_start_key`](Self::set_exclusive_start_key).
|
599 + | /// /* BuilderGenerator.kt:438 */To override the contents of this collection use [`set_exclusive_start_key`](Self::set_exclusive_start_key).
|
600 + | /* BuilderGenerator.kt:439 */
|
457 601 | ///
|
458 - | /// <p>The primary key of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedKey</code> in the previous operation.</p>
|
602 + | /// /* BuilderGenerator.kt:440 */<p>The primary key of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedKey</code> in the previous operation.</p>
|
459 603 | /// <p>The data type for <code>ExclusiveStartKey</code> must be String, Number or Binary. No set data types are allowed.</p>
|
460 604 | /// <p>In a parallel scan, a <code>Scan</code> request that includes <code>ExclusiveStartKey</code> must specify the same segment whose previous <code>Scan</code> returned the corresponding value of <code>LastEvaluatedKey</code>.</p>
|
605 + | /* BuilderGenerator.kt:445 */
|
461 606 | pub fn exclusive_start_key(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::AttributeValue) -> Self {
|
607 + | /* BuilderGenerator.kt:448 */
|
462 608 | let mut hash_map = self.exclusive_start_key.unwrap_or_default();
|
463 609 | hash_map.insert(k.into(), v);
|
464 610 | self.exclusive_start_key = ::std::option::Option::Some(hash_map);
|
465 611 | self
|
612 + | /* BuilderGenerator.kt:445 */
|
466 613 | }
|
467 - | /// <p>The primary key of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedKey</code> in the previous operation.</p>
|
614 + | /// /* BuilderGenerator.kt:312 */<p>The primary key of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedKey</code> in the previous operation.</p>
|
468 615 | /// <p>The data type for <code>ExclusiveStartKey</code> must be String, Number or Binary. No set data types are allowed.</p>
|
469 616 | /// <p>In a parallel scan, a <code>Scan</code> request that includes <code>ExclusiveStartKey</code> must specify the same segment whose previous <code>Scan</code> returned the corresponding value of <code>LastEvaluatedKey</code>.</p>
|
617 + | /* BuilderGenerator.kt:314 */
|
470 618 | pub fn set_exclusive_start_key(
|
471 619 | mut self,
|
472 620 | input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
|
473 621 | ) -> Self {
|
622 + | /* BuilderGenerator.kt:315 */
|
474 623 | self.exclusive_start_key = input;
|
475 624 | self
|
625 + | /* BuilderGenerator.kt:314 */
|
476 626 | }
|
477 - | /// <p>The primary key of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedKey</code> in the previous operation.</p>
|
627 + | /// /* BuilderGenerator.kt:334 */<p>The primary key of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedKey</code> in the previous operation.</p>
|
478 628 | /// <p>The data type for <code>ExclusiveStartKey</code> must be String, Number or Binary. No set data types are allowed.</p>
|
479 629 | /// <p>In a parallel scan, a <code>Scan</code> request that includes <code>ExclusiveStartKey</code> must specify the same segment whose previous <code>Scan</code> returned the corresponding value of <code>LastEvaluatedKey</code>.</p>
|
630 + | /* BuilderGenerator.kt:336 */
|
480 631 | pub fn get_exclusive_start_key(
|
481 632 | &self,
|
482 633 | ) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>> {
|
634 + | /* BuilderGenerator.kt:337 */
|
483 635 | &self.exclusive_start_key
|
636 + | /* BuilderGenerator.kt:336 */
|
484 637 | }
|
485 - | /// <p>Determines the level of detail about provisioned throughput consumption that is returned in the response:</p>
|
638 + | /// /* BuilderGenerator.kt:286 */<p>Determines the level of detail about provisioned throughput consumption that is returned in the response:</p>
|
486 639 | /// <ul>
|
487 640 | /// <li>
|
488 641 | /// <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>
|
489 642 | /// <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>
|
490 643 | /// <li>
|
491 644 | /// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
|
492 645 | /// <li>
|
493 646 | /// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
|
494 647 | /// </ul>
|
648 + | /* BuilderGenerator.kt:291 */
|
495 649 | pub fn return_consumed_capacity(mut self, input: crate::types::ReturnConsumedCapacity) -> Self {
|
650 + | /* BuilderGenerator.kt:292 */
|
496 651 | self.return_consumed_capacity = ::std::option::Option::Some(input);
|
652 + | /* BuilderGenerator.kt:293 */
|
497 653 | self
|
654 + | /* BuilderGenerator.kt:291 */
|
498 655 | }
|
499 - | /// <p>Determines the level of detail about provisioned throughput consumption that is returned in the response:</p>
|
656 + | /// /* BuilderGenerator.kt:312 */<p>Determines the level of detail about provisioned throughput consumption that is returned in the response:</p>
|
500 657 | /// <ul>
|
501 658 | /// <li>
|
502 659 | /// <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>
|
503 660 | /// <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>
|
504 661 | /// <li>
|
505 662 | /// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
|
506 663 | /// <li>
|
507 664 | /// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
|
508 665 | /// </ul>
|
666 + | /* BuilderGenerator.kt:314 */
|
509 667 | pub fn set_return_consumed_capacity(mut self, input: ::std::option::Option<crate::types::ReturnConsumedCapacity>) -> Self {
|
668 + | /* BuilderGenerator.kt:315 */
|
510 669 | self.return_consumed_capacity = input;
|
511 670 | self
|
671 + | /* BuilderGenerator.kt:314 */
|
512 672 | }
|
513 - | /// <p>Determines the level of detail about provisioned throughput consumption that is returned in the response:</p>
|
673 + | /// /* BuilderGenerator.kt:334 */<p>Determines the level of detail about provisioned throughput consumption that is returned in the response:</p>
|
514 674 | /// <ul>
|
515 675 | /// <li>
|
516 676 | /// <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>
|
517 677 | /// <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>
|
518 678 | /// <li>
|
519 679 | /// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
|
520 680 | /// <li>
|
521 681 | /// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
|
522 682 | /// </ul>
|
683 + | /* BuilderGenerator.kt:336 */
|
523 684 | pub fn get_return_consumed_capacity(&self) -> &::std::option::Option<crate::types::ReturnConsumedCapacity> {
|
685 + | /* BuilderGenerator.kt:337 */
|
524 686 | &self.return_consumed_capacity
|
687 + | /* BuilderGenerator.kt:336 */
|
525 688 | }
|
526 - | /// <p>For a parallel <code>Scan</code> request, <code>TotalSegments</code> represents the total number of segments into which the <code>Scan</code> operation will be divided. The value of <code>TotalSegments</code> corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a <code>TotalSegments</code> value of 4.</p>
|
689 + | /// /* BuilderGenerator.kt:286 */<p>For a parallel <code>Scan</code> request, <code>TotalSegments</code> represents the total number of segments into which the <code>Scan</code> operation will be divided. The value of <code>TotalSegments</code> corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a <code>TotalSegments</code> value of 4.</p>
|
527 690 | /// <p>The value for <code>TotalSegments</code> must be greater than or equal to 1, and less than or equal to 1000000. If you specify a <code>TotalSegments</code> value of 1, the <code>Scan</code> operation will be sequential rather than parallel.</p>
|
528 691 | /// <p>If you specify <code>TotalSegments</code>, you must also specify <code>Segment</code>.</p>
|
692 + | /* BuilderGenerator.kt:291 */
|
529 693 | pub fn total_segments(mut self, input: i32) -> Self {
|
694 + | /* BuilderGenerator.kt:292 */
|
530 695 | self.total_segments = ::std::option::Option::Some(input);
|
696 + | /* BuilderGenerator.kt:293 */
|
531 697 | self
|
698 + | /* BuilderGenerator.kt:291 */
|
532 699 | }
|
533 - | /// <p>For a parallel <code>Scan</code> request, <code>TotalSegments</code> represents the total number of segments into which the <code>Scan</code> operation will be divided. The value of <code>TotalSegments</code> corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a <code>TotalSegments</code> value of 4.</p>
|
700 + | /// /* BuilderGenerator.kt:312 */<p>For a parallel <code>Scan</code> request, <code>TotalSegments</code> represents the total number of segments into which the <code>Scan</code> operation will be divided. The value of <code>TotalSegments</code> corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a <code>TotalSegments</code> value of 4.</p>
|
534 701 | /// <p>The value for <code>TotalSegments</code> must be greater than or equal to 1, and less than or equal to 1000000. If you specify a <code>TotalSegments</code> value of 1, the <code>Scan</code> operation will be sequential rather than parallel.</p>
|
535 702 | /// <p>If you specify <code>TotalSegments</code>, you must also specify <code>Segment</code>.</p>
|
703 + | /* BuilderGenerator.kt:314 */
|
536 704 | pub fn set_total_segments(mut self, input: ::std::option::Option<i32>) -> Self {
|
705 + | /* BuilderGenerator.kt:315 */
|
537 706 | self.total_segments = input;
|
538 707 | self
|
708 + | /* BuilderGenerator.kt:314 */
|
539 709 | }
|
540 - | /// <p>For a parallel <code>Scan</code> request, <code>TotalSegments</code> represents the total number of segments into which the <code>Scan</code> operation will be divided. The value of <code>TotalSegments</code> corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a <code>TotalSegments</code> value of 4.</p>
|
710 + | /// /* BuilderGenerator.kt:334 */<p>For a parallel <code>Scan</code> request, <code>TotalSegments</code> represents the total number of segments into which the <code>Scan</code> operation will be divided. The value of <code>TotalSegments</code> corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a <code>TotalSegments</code> value of 4.</p>
|
541 711 | /// <p>The value for <code>TotalSegments</code> must be greater than or equal to 1, and less than or equal to 1000000. If you specify a <code>TotalSegments</code> value of 1, the <code>Scan</code> operation will be sequential rather than parallel.</p>
|
542 712 | /// <p>If you specify <code>TotalSegments</code>, you must also specify <code>Segment</code>.</p>
|
713 + | /* BuilderGenerator.kt:336 */
|
543 714 | pub fn get_total_segments(&self) -> &::std::option::Option<i32> {
|
715 + | /* BuilderGenerator.kt:337 */
|
544 716 | &self.total_segments
|
717 + | /* BuilderGenerator.kt:336 */
|
545 718 | }
|
546 - | /// <p>For a parallel <code>Scan</code> request, <code>Segment</code> identifies an individual segment to be scanned by an application worker.</p>
|
719 + | /// /* BuilderGenerator.kt:286 */<p>For a parallel <code>Scan</code> request, <code>Segment</code> identifies an individual segment to be scanned by an application worker.</p>
|
547 720 | /// <p>Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a <code>Segment</code> value of 0, the second thread specifies 1, and so on.</p>
|
548 721 | /// <p>The value of <code>LastEvaluatedKey</code> returned from a parallel <code>Scan</code> request must be used as <code>ExclusiveStartKey</code> with the same segment ID in a subsequent <code>Scan</code> operation.</p>
|
549 722 | /// <p>The value for <code>Segment</code> must be greater than or equal to 0, and less than the value provided for <code>TotalSegments</code>.</p>
|
550 723 | /// <p>If you provide <code>Segment</code>, you must also provide <code>TotalSegments</code>.</p>
|
724 + | /* BuilderGenerator.kt:291 */
|
551 725 | pub fn segment(mut self, input: i32) -> Self {
|
726 + | /* BuilderGenerator.kt:292 */
|
552 727 | self.segment = ::std::option::Option::Some(input);
|
728 + | /* BuilderGenerator.kt:293 */
|
553 729 | self
|
730 + | /* BuilderGenerator.kt:291 */
|
554 731 | }
|
555 - | /// <p>For a parallel <code>Scan</code> request, <code>Segment</code> identifies an individual segment to be scanned by an application worker.</p>
|
732 + | /// /* BuilderGenerator.kt:312 */<p>For a parallel <code>Scan</code> request, <code>Segment</code> identifies an individual segment to be scanned by an application worker.</p>
|
556 733 | /// <p>Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a <code>Segment</code> value of 0, the second thread specifies 1, and so on.</p>
|
557 734 | /// <p>The value of <code>LastEvaluatedKey</code> returned from a parallel <code>Scan</code> request must be used as <code>ExclusiveStartKey</code> with the same segment ID in a subsequent <code>Scan</code> operation.</p>
|
558 735 | /// <p>The value for <code>Segment</code> must be greater than or equal to 0, and less than the value provided for <code>TotalSegments</code>.</p>
|
559 736 | /// <p>If you provide <code>Segment</code>, you must also provide <code>TotalSegments</code>.</p>
|
737 + | /* BuilderGenerator.kt:314 */
|
560 738 | pub fn set_segment(mut self, input: ::std::option::Option<i32>) -> Self {
|
739 + | /* BuilderGenerator.kt:315 */
|
561 740 | self.segment = input;
|
562 741 | self
|
742 + | /* BuilderGenerator.kt:314 */
|
563 743 | }
|
564 - | /// <p>For a parallel <code>Scan</code> request, <code>Segment</code> identifies an individual segment to be scanned by an application worker.</p>
|
744 + | /// /* BuilderGenerator.kt:334 */<p>For a parallel <code>Scan</code> request, <code>Segment</code> identifies an individual segment to be scanned by an application worker.</p>
|
565 745 | /// <p>Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a <code>Segment</code> value of 0, the second thread specifies 1, and so on.</p>
|
566 746 | /// <p>The value of <code>LastEvaluatedKey</code> returned from a parallel <code>Scan</code> request must be used as <code>ExclusiveStartKey</code> with the same segment ID in a subsequent <code>Scan</code> operation.</p>
|
567 747 | /// <p>The value for <code>Segment</code> must be greater than or equal to 0, and less than the value provided for <code>TotalSegments</code>.</p>
|
568 748 | /// <p>If you provide <code>Segment</code>, you must also provide <code>TotalSegments</code>.</p>
|
749 + | /* BuilderGenerator.kt:336 */
|
569 750 | pub fn get_segment(&self) -> &::std::option::Option<i32> {
|
751 + | /* BuilderGenerator.kt:337 */
|
570 752 | &self.segment
|
753 + | /* BuilderGenerator.kt:336 */
|
571 754 | }
|
572 - | /// <p>A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.</p>
|
755 + | /// /* BuilderGenerator.kt:286 */<p>A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.</p>
|
573 756 | /// <p>If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.</p>
|
574 757 | /// <p>For more information, 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>
|
758 + | /* BuilderGenerator.kt:291 */
|
575 759 | pub fn projection_expression(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
|
760 + | /* BuilderGenerator.kt:292 */
|
576 761 | self.projection_expression = ::std::option::Option::Some(input.into());
|
762 + | /* BuilderGenerator.kt:293 */
|
577 763 | self
|
764 + | /* BuilderGenerator.kt:291 */
|
578 765 | }
|
579 - | /// <p>A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.</p>
|
766 + | /// /* BuilderGenerator.kt:312 */<p>A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.</p>
|
580 767 | /// <p>If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.</p>
|
581 768 | /// <p>For more information, 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>
|
769 + | /* BuilderGenerator.kt:314 */
|
582 770 | pub fn set_projection_expression(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
|
771 + | /* BuilderGenerator.kt:315 */
|
583 772 | self.projection_expression = input;
|
584 773 | self
|
774 + | /* BuilderGenerator.kt:314 */
|
585 775 | }
|
586 - | /// <p>A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.</p>
|
776 + | /// /* BuilderGenerator.kt:334 */<p>A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.</p>
|
587 777 | /// <p>If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.</p>
|
588 778 | /// <p>For more information, 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>
|
779 + | /* BuilderGenerator.kt:336 */
|
589 780 | pub fn get_projection_expression(&self) -> &::std::option::Option<::std::string::String> {
|
781 + | /* BuilderGenerator.kt:337 */
|
590 782 | &self.projection_expression
|
783 + | /* BuilderGenerator.kt:336 */
|
591 784 | }
|
592 - | /// <p>A string that contains conditions that DynamoDB applies after the <code>Scan</code> operation, but before the data is returned to you. Items that do not satisfy the <code>FilterExpression</code> criteria are not returned.</p><note>
|
785 + | /// /* BuilderGenerator.kt:286 */<p>A string that contains conditions that DynamoDB applies after the <code>Scan</code> operation, but before the data is returned to you. Items that do not satisfy the <code>FilterExpression</code> criteria are not returned.</p><note>
|
593 786 | /// <p>A <code>FilterExpression</code> is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.</p>
|
594 787 | /// </note>
|
595 788 | /// <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#FilteringResults">Filter Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
789 + | /* BuilderGenerator.kt:291 */
|
596 790 | pub fn filter_expression(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
|
791 + | /* BuilderGenerator.kt:292 */
|
597 792 | self.filter_expression = ::std::option::Option::Some(input.into());
|
793 + | /* BuilderGenerator.kt:293 */
|
598 794 | self
|
795 + | /* BuilderGenerator.kt:291 */
|
599 796 | }
|
600 - | /// <p>A string that contains conditions that DynamoDB applies after the <code>Scan</code> operation, but before the data is returned to you. Items that do not satisfy the <code>FilterExpression</code> criteria are not returned.</p><note>
|
797 + | /// /* BuilderGenerator.kt:312 */<p>A string that contains conditions that DynamoDB applies after the <code>Scan</code> operation, but before the data is returned to you. Items that do not satisfy the <code>FilterExpression</code> criteria are not returned.</p><note>
|
601 798 | /// <p>A <code>FilterExpression</code> is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.</p>
|
602 799 | /// </note>
|
603 800 | /// <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#FilteringResults">Filter Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
801 + | /* BuilderGenerator.kt:314 */
|
604 802 | pub fn set_filter_expression(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
|
803 + | /* BuilderGenerator.kt:315 */
|
605 804 | self.filter_expression = input;
|
606 805 | self
|
806 + | /* BuilderGenerator.kt:314 */
|
607 807 | }
|
608 - | /// <p>A string that contains conditions that DynamoDB applies after the <code>Scan</code> operation, but before the data is returned to you. Items that do not satisfy the <code>FilterExpression</code> criteria are not returned.</p><note>
|
808 + | /// /* BuilderGenerator.kt:334 */<p>A string that contains conditions that DynamoDB applies after the <code>Scan</code> operation, but before the data is returned to you. Items that do not satisfy the <code>FilterExpression</code> criteria are not returned.</p><note>
|
609 809 | /// <p>A <code>FilterExpression</code> is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.</p>
|
610 810 | /// </note>
|
611 811 | /// <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#FilteringResults">Filter Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
812 + | /* BuilderGenerator.kt:336 */
|
612 813 | pub fn get_filter_expression(&self) -> &::std::option::Option<::std::string::String> {
|
814 + | /* BuilderGenerator.kt:337 */
|
613 815 | &self.filter_expression
|
816 + | /* BuilderGenerator.kt:336 */
|
614 817 | }
|
615 - | /// Adds a key-value pair to `expression_attribute_names`.
|
818 + | /// /* BuilderGenerator.kt:436 */Adds a key-value pair to `expression_attribute_names`.
|
819 + | /* BuilderGenerator.kt:437 */
|
616 820 | ///
|
617 - | /// To override the contents of this collection use [`set_expression_attribute_names`](Self::set_expression_attribute_names).
|
821 + | /// /* BuilderGenerator.kt:438 */To override the contents of this collection use [`set_expression_attribute_names`](Self::set_expression_attribute_names).
|
822 + | /* BuilderGenerator.kt:439 */
|
618 823 | ///
|
619 - | /// <p>One or more substitution tokens for attribute names in an expression. The following are some use cases for using <code>ExpressionAttributeNames</code>:</p>
|
824 + | /// /* 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>
|
620 825 | /// <ul>
|
621 826 | /// <li>
|
622 827 | /// <p>To access an attribute whose name conflicts with a DynamoDB reserved word.</p></li>
|
623 828 | /// <li>
|
624 829 | /// <p>To create a placeholder for repeating occurrences of an attribute name in an expression.</p></li>
|
625 830 | /// <li>
|
626 831 | /// <p>To prevent special characters in an attribute name from being misinterpreted in an expression.</p></li>
|
627 832 | /// </ul>
|
628 833 | /// <p>Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name:</p>
|
629 834 | /// <ul>
|
630 835 | /// <li>
|
631 836 | /// <p><code>Percentile</code></p></li>
|
632 837 | /// </ul>
|
633 838 | /// <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>
|
634 839 | /// <ul>
|
635 840 | /// <li>
|
636 841 | /// <p><code>{"#P":"Percentile"}</code></p></li>
|
637 842 | /// </ul>
|
638 843 | /// <p>You could then use this substitution in an expression, as in this example:</p>
|
639 844 | /// <ul>
|
640 845 | /// <li>
|
641 846 | /// <p><code>#P = :val</code></p></li>
|
642 847 | /// </ul><note>
|
643 848 | /// <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>
|
644 849 | /// </note>
|
645 850 | /// <p>For more information on 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>
|
851 + | /* BuilderGenerator.kt:445 */
|
646 852 | pub fn expression_attribute_names(
|
647 853 | mut self,
|
648 854 | k: impl ::std::convert::Into<::std::string::String>,
|
649 855 | v: impl ::std::convert::Into<::std::string::String>,
|
650 856 | ) -> Self {
|
857 + | /* BuilderGenerator.kt:448 */
|
651 858 | let mut hash_map = self.expression_attribute_names.unwrap_or_default();
|
652 859 | hash_map.insert(k.into(), v.into());
|
653 860 | self.expression_attribute_names = ::std::option::Option::Some(hash_map);
|
654 861 | self
|
862 + | /* BuilderGenerator.kt:445 */
|
655 863 | }
|
656 - | /// <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: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>
|
657 865 | /// <ul>
|
658 866 | /// <li>
|
659 867 | /// <p>To access an attribute whose name conflicts with a DynamoDB reserved word.</p></li>
|
660 868 | /// <li>
|
661 869 | /// <p>To create a placeholder for repeating occurrences of an attribute name in an expression.</p></li>
|
662 870 | /// <li>
|
663 871 | /// <p>To prevent special characters in an attribute name from being misinterpreted in an expression.</p></li>
|
664 872 | /// </ul>
|
665 873 | /// <p>Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name:</p>
|
666 874 | /// <ul>
|
667 875 | /// <li>
|
668 876 | /// <p><code>Percentile</code></p></li>
|
669 877 | /// </ul>
|
670 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>
|
671 879 | /// <ul>
|
672 880 | /// <li>
|
673 881 | /// <p><code>{"#P":"Percentile"}</code></p></li>
|
674 882 | /// </ul>
|
675 883 | /// <p>You could then use this substitution in an expression, as in this example:</p>
|
676 884 | /// <ul>
|
677 885 | /// <li>
|
678 886 | /// <p><code>#P = :val</code></p></li>
|
679 887 | /// </ul><note>
|
680 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>
|
681 889 | /// </note>
|
682 890 | /// <p>For more information on 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:314 */
|
683 892 | pub fn set_expression_attribute_names(
|
684 893 | mut self,
|
685 894 | input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
|
686 895 | ) -> Self {
|
896 + | /* BuilderGenerator.kt:315 */
|
687 897 | self.expression_attribute_names = input;
|
688 898 | self
|
899 + | /* BuilderGenerator.kt:314 */
|
689 900 | }
|
690 - | /// <p>One or more substitution tokens for attribute names in an expression. The following are some use cases for using <code>ExpressionAttributeNames</code>:</p>
|
901 + | /// /* 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>
|
691 902 | /// <ul>
|
692 903 | /// <li>
|
693 904 | /// <p>To access an attribute whose name conflicts with a DynamoDB reserved word.</p></li>
|
694 905 | /// <li>
|
695 906 | /// <p>To create a placeholder for repeating occurrences of an attribute name in an expression.</p></li>
|
696 907 | /// <li>
|
697 908 | /// <p>To prevent special characters in an attribute name from being misinterpreted in an expression.</p></li>
|
698 909 | /// </ul>
|
699 910 | /// <p>Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name:</p>
|
700 911 | /// <ul>
|
701 912 | /// <li>
|
702 913 | /// <p><code>Percentile</code></p></li>
|
703 914 | /// </ul>
|
704 915 | /// <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>
|
705 916 | /// <ul>
|
706 917 | /// <li>
|
707 918 | /// <p><code>{"#P":"Percentile"}</code></p></li>
|
708 919 | /// </ul>
|
709 920 | /// <p>You could then use this substitution in an expression, as in this example:</p>
|
710 921 | /// <ul>
|
711 922 | /// <li>
|
712 923 | /// <p><code>#P = :val</code></p></li>
|
713 924 | /// </ul><note>
|
714 925 | /// <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>
|
715 926 | /// </note>
|
716 927 | /// <p>For more information on 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>
|
928 + | /* BuilderGenerator.kt:336 */
|
717 929 | pub fn get_expression_attribute_names(
|
718 930 | &self,
|
719 931 | ) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
|
932 + | /* BuilderGenerator.kt:337 */
|
720 933 | &self.expression_attribute_names
|
934 + | /* BuilderGenerator.kt:336 */
|
721 935 | }
|
722 - | /// Adds a key-value pair to `expression_attribute_values`.
|
936 + | /// /* BuilderGenerator.kt:436 */Adds a key-value pair to `expression_attribute_values`.
|
937 + | /* BuilderGenerator.kt:437 */
|
723 938 | ///
|
724 - | /// To override the contents of this collection use [`set_expression_attribute_values`](Self::set_expression_attribute_values).
|
939 + | /// /* BuilderGenerator.kt:438 */To override the contents of this collection use [`set_expression_attribute_values`](Self::set_expression_attribute_values).
|
940 + | /* BuilderGenerator.kt:439 */
|
725 941 | ///
|
726 - | /// <p>One or more values that can be substituted in an expression.</p>
|
942 + | /// /* BuilderGenerator.kt:440 */<p>One or more values that can be substituted in an expression.</p>
|
727 943 | /// <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>
|
728 944 | /// <p><code>Available | Backordered | Discontinued</code></p>
|
729 945 | /// <p>You would first need to specify <code>ExpressionAttributeValues</code> as follows:</p>
|
730 946 | /// <p><code>{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }</code></p>
|
731 947 | /// <p>You could then use these values in an expression, such as this:</p>
|
732 948 | /// <p><code>ProductStatus IN (:avail, :back, :disc)</code></p>
|
733 949 | /// <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>
|
950 + | /* BuilderGenerator.kt:445 */
|
734 951 | pub fn expression_attribute_values(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::AttributeValue) -> Self {
|
952 + | /* BuilderGenerator.kt:448 */
|
735 953 | let mut hash_map = self.expression_attribute_values.unwrap_or_default();
|
736 954 | hash_map.insert(k.into(), v);
|
737 955 | self.expression_attribute_values = ::std::option::Option::Some(hash_map);
|
738 956 | self
|
957 + | /* BuilderGenerator.kt:445 */
|
739 958 | }
|
740 - | /// <p>One or more values that can be substituted in an expression.</p>
|
959 + | /// /* BuilderGenerator.kt:312 */<p>One or more values that can be substituted in an expression.</p>
|
741 960 | /// <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>
|
742 961 | /// <p><code>Available | Backordered | Discontinued</code></p>
|
743 962 | /// <p>You would first need to specify <code>ExpressionAttributeValues</code> as follows:</p>
|
744 963 | /// <p><code>{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }</code></p>
|
745 964 | /// <p>You could then use these values in an expression, such as this:</p>
|
746 965 | /// <p><code>ProductStatus IN (:avail, :back, :disc)</code></p>
|
747 966 | /// <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>
|
967 + | /* BuilderGenerator.kt:314 */
|
748 968 | pub fn set_expression_attribute_values(
|
749 969 | mut self,
|
750 970 | input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
|
751 971 | ) -> Self {
|
972 + | /* BuilderGenerator.kt:315 */
|
752 973 | self.expression_attribute_values = input;
|
753 974 | self
|
975 + | /* BuilderGenerator.kt:314 */
|
754 976 | }
|
755 - | /// <p>One or more values that can be substituted in an expression.</p>
|
977 + | /// /* BuilderGenerator.kt:334 */<p>One or more values that can be substituted in an expression.</p>
|
756 978 | /// <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>
|
757 979 | /// <p><code>Available | Backordered | Discontinued</code></p>
|
758 980 | /// <p>You would first need to specify <code>ExpressionAttributeValues</code> as follows:</p>
|
759 981 | /// <p><code>{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }</code></p>
|
760 982 | /// <p>You could then use these values in an expression, such as this:</p>
|
761 983 | /// <p><code>ProductStatus IN (:avail, :back, :disc)</code></p>
|
762 984 | /// <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>
|
985 + | /* BuilderGenerator.kt:336 */
|
763 986 | pub fn get_expression_attribute_values(
|
764 987 | &self,
|
765 988 | ) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>> {
|
989 + | /* BuilderGenerator.kt:337 */
|
766 990 | &self.expression_attribute_values
|
991 + | /* BuilderGenerator.kt:336 */
|
767 992 | }
|
768 - | /// <p>A Boolean value that determines the read consistency model during the scan:</p>
|
993 + | /// /* BuilderGenerator.kt:286 */<p>A Boolean value that determines the read consistency model during the scan:</p>
|
769 994 | /// <ul>
|
770 995 | /// <li>
|
771 996 | /// <p>If <code>ConsistentRead</code> is <code>false</code>, then the data returned from <code>Scan</code> might not contain the results from other recently completed write operations (<code>PutItem</code>, <code>UpdateItem</code>, or <code>DeleteItem</code>).</p></li>
|
772 997 | /// <li>
|
773 998 | /// <p>If <code>ConsistentRead</code> is <code>true</code>, then all of the write operations that completed before the <code>Scan</code> began are guaranteed to be contained in the <code>Scan</code> response.</p></li>
|
774 999 | /// </ul>
|
775 1000 | /// <p>The default setting for <code>ConsistentRead</code> is <code>false</code>.</p>
|
776 1001 | /// <p>The <code>ConsistentRead</code> parameter is not supported on global secondary indexes. If you scan a global secondary index with <code>ConsistentRead</code> set to true, you will receive a <code>ValidationException</code>.</p>
|
1002 + | /* BuilderGenerator.kt:291 */
|
777 1003 | pub fn consistent_read(mut self, input: bool) -> Self {
|
1004 + | /* BuilderGenerator.kt:292 */
|
778 1005 | self.consistent_read = ::std::option::Option::Some(input);
|
1006 + | /* BuilderGenerator.kt:293 */
|
779 1007 | self
|
1008 + | /* BuilderGenerator.kt:291 */
|
780 1009 | }
|
781 - | /// <p>A Boolean value that determines the read consistency model during the scan:</p>
|
1010 + | /// /* BuilderGenerator.kt:312 */<p>A Boolean value that determines the read consistency model during the scan:</p>
|
782 1011 | /// <ul>
|
783 1012 | /// <li>
|
784 1013 | /// <p>If <code>ConsistentRead</code> is <code>false</code>, then the data returned from <code>Scan</code> might not contain the results from other recently completed write operations (<code>PutItem</code>, <code>UpdateItem</code>, or <code>DeleteItem</code>).</p></li>
|
785 1014 | /// <li>
|
786 1015 | /// <p>If <code>ConsistentRead</code> is <code>true</code>, then all of the write operations that completed before the <code>Scan</code> began are guaranteed to be contained in the <code>Scan</code> response.</p></li>
|
787 1016 | /// </ul>
|
788 1017 | /// <p>The default setting for <code>ConsistentRead</code> is <code>false</code>.</p>
|
789 1018 | /// <p>The <code>ConsistentRead</code> parameter is not supported on global secondary indexes. If you scan a global secondary index with <code>ConsistentRead</code> set to true, you will receive a <code>ValidationException</code>.</p>
|
1019 + | /* BuilderGenerator.kt:314 */
|
790 1020 | pub fn set_consistent_read(mut self, input: ::std::option::Option<bool>) -> Self {
|
1021 + | /* BuilderGenerator.kt:315 */
|
791 1022 | self.consistent_read = input;
|
792 1023 | self
|
1024 + | /* BuilderGenerator.kt:314 */
|
793 1025 | }
|
794 - | /// <p>A Boolean value that determines the read consistency model during the scan:</p>
|
1026 + | /// /* BuilderGenerator.kt:334 */<p>A Boolean value that determines the read consistency model during the scan:</p>
|
795 1027 | /// <ul>
|
796 1028 | /// <li>
|
797 1029 | /// <p>If <code>ConsistentRead</code> is <code>false</code>, then the data returned from <code>Scan</code> might not contain the results from other recently completed write operations (<code>PutItem</code>, <code>UpdateItem</code>, or <code>DeleteItem</code>).</p></li>
|
798 1030 | /// <li>
|
799 1031 | /// <p>If <code>ConsistentRead</code> is <code>true</code>, then all of the write operations that completed before the <code>Scan</code> began are guaranteed to be contained in the <code>Scan</code> response.</p></li>
|
800 1032 | /// </ul>
|
801 1033 | /// <p>The default setting for <code>ConsistentRead</code> is <code>false</code>.</p>
|
802 1034 | /// <p>The <code>ConsistentRead</code> parameter is not supported on global secondary indexes. If you scan a global secondary index with <code>ConsistentRead</code> set to true, you will receive a <code>ValidationException</code>.</p>
|
1035 + | /* BuilderGenerator.kt:336 */
|
803 1036 | pub fn get_consistent_read(&self) -> &::std::option::Option<bool> {
|
1037 + | /* BuilderGenerator.kt:337 */
|
804 1038 | &self.consistent_read
|
1039 + | /* BuilderGenerator.kt:336 */
|
805 1040 | }
|
806 - | /// Consumes the builder and constructs a [`ScanInput`](crate::operation::scan::ScanInput).
|
1041 + | /// /* BuilderGenerator.kt:240 */Consumes the builder and constructs a [`ScanInput`](crate::operation::scan::ScanInput).
|
1042 + | /* BuilderGenerator.kt:253 */
|
807 1043 | pub fn build(self) -> ::std::result::Result<crate::operation::scan::ScanInput, ::aws_smithy_types::error::operation::BuildError> {
|
808 - | ::std::result::Result::Ok(crate::operation::scan::ScanInput {
|
809 - | table_name: self.table_name,
|
1044 + | /* BuilderGenerator.kt:254 */
|
1045 + | ::std::result::Result::Ok(
|
1046 + | /* BuilderGenerator.kt:477 */
|
1047 + | crate::operation::scan::ScanInput {
|
1048 + | /* BuilderGenerator.kt:481 */ table_name: self.table_name,
|
1049 + | /* BuilderGenerator.kt:481 */
|
810 1050 | index_name: self.index_name,
|
1051 + | /* BuilderGenerator.kt:481 */
|
811 1052 | attributes_to_get: self.attributes_to_get,
|
1053 + | /* BuilderGenerator.kt:481 */
|
812 1054 | limit: self.limit,
|
1055 + | /* BuilderGenerator.kt:481 */
|
813 1056 | select: self.select,
|
1057 + | /* BuilderGenerator.kt:481 */
|
814 1058 | scan_filter: self.scan_filter,
|
1059 + | /* BuilderGenerator.kt:481 */
|
815 1060 | conditional_operator: self.conditional_operator,
|
1061 + | /* BuilderGenerator.kt:481 */
|
816 1062 | exclusive_start_key: self.exclusive_start_key,
|
1063 + | /* BuilderGenerator.kt:481 */
|
817 1064 | return_consumed_capacity: self.return_consumed_capacity,
|
1065 + | /* BuilderGenerator.kt:481 */
|
818 1066 | total_segments: self.total_segments,
|
1067 + | /* BuilderGenerator.kt:481 */
|
819 1068 | segment: self.segment,
|
1069 + | /* BuilderGenerator.kt:481 */
|
820 1070 | projection_expression: self.projection_expression,
|
1071 + | /* BuilderGenerator.kt:481 */
|
821 1072 | filter_expression: self.filter_expression,
|
1073 + | /* BuilderGenerator.kt:481 */
|
822 1074 | expression_attribute_names: self.expression_attribute_names,
|
1075 + | /* BuilderGenerator.kt:481 */
|
823 1076 | expression_attribute_values: self.expression_attribute_values,
|
1077 + | /* BuilderGenerator.kt:481 */
|
824 1078 | consistent_read: self.consistent_read,
|
825 - | })
|
1079 + | /* BuilderGenerator.kt:477 */
|
1080 + | }, /* BuilderGenerator.kt:254 */
|
1081 + | )
|
1082 + | /* BuilderGenerator.kt:253 */
|
826 1083 | }
|
1084 + | /* BuilderGenerator.kt:355 */
|
827 1085 | }
|