AWS SDK for C++

AWS SDK for C++ Version 1.11.743

Loading...
Searching...
No Matches
UpdateItemRequest.h
1
6#pragma once
7#include <aws/core/utils/memory/stl/AWSMap.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/dynamodb/DynamoDBRequest.h>
10#include <aws/dynamodb/DynamoDB_EXPORTS.h>
11#include <aws/dynamodb/model/AttributeValue.h>
12#include <aws/dynamodb/model/AttributeValueUpdate.h>
13#include <aws/dynamodb/model/ConditionalOperator.h>
14#include <aws/dynamodb/model/ExpectedAttributeValue.h>
15#include <aws/dynamodb/model/ReturnConsumedCapacity.h>
16#include <aws/dynamodb/model/ReturnItemCollectionMetrics.h>
17#include <aws/dynamodb/model/ReturnValue.h>
18#include <aws/dynamodb/model/ReturnValuesOnConditionCheckFailure.h>
19
20#include <utility>
21
22namespace Aws {
23namespace DynamoDB {
24namespace Model {
25
33 public:
34 AWS_DYNAMODB_API UpdateItemRequest() = default;
35
36 // Service request name is the Operation name which will send this request out,
37 // each operation should has unique request name, so that we can get operation's name from this request.
38 // Note: this is not true for response, multiple operations may have the same response name,
39 // so we can not get operation's name from response.
40 inline virtual const char* GetServiceRequestName() const override { return "UpdateItem"; }
41
42 AWS_DYNAMODB_API Aws::String SerializePayload() const override;
43
45
49 AWS_DYNAMODB_API EndpointParameters GetEndpointContextParams() const override;
50
52
56 inline const Aws::String& GetTableName() const { return m_tableName; }
57 inline bool TableNameHasBeenSet() const { return m_tableNameHasBeenSet; }
58 template <typename TableNameT = Aws::String>
59 void SetTableName(TableNameT&& value) {
60 m_tableNameHasBeenSet = true;
61 m_tableName = std::forward<TableNameT>(value);
62 }
63 template <typename TableNameT = Aws::String>
64 UpdateItemRequest& WithTableName(TableNameT&& value) {
65 SetTableName(std::forward<TableNameT>(value));
66 return *this;
67 }
69
71
78 inline const Aws::Map<Aws::String, AttributeValue>& GetKey() const { return m_key; }
79 inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
80 template <typename KeyT = Aws::Map<Aws::String, AttributeValue>>
81 void SetKey(KeyT&& value) {
82 m_keyHasBeenSet = true;
83 m_key = std::forward<KeyT>(value);
84 }
85 template <typename KeyT = Aws::Map<Aws::String, AttributeValue>>
86 UpdateItemRequest& WithKey(KeyT&& value) {
87 SetKey(std::forward<KeyT>(value));
88 return *this;
89 }
90 template <typename KeyKeyT = Aws::String, typename KeyValueT = AttributeValue>
91 UpdateItemRequest& AddKey(KeyKeyT&& key, KeyValueT&& value) {
92 m_keyHasBeenSet = true;
93 m_key.emplace(std::forward<KeyKeyT>(key), std::forward<KeyValueT>(value));
94 return *this;
95 }
97
99
105 inline const Aws::Map<Aws::String, AttributeValueUpdate>& GetAttributeUpdates() const { return m_attributeUpdates; }
106 inline bool AttributeUpdatesHasBeenSet() const { return m_attributeUpdatesHasBeenSet; }
107 template <typename AttributeUpdatesT = Aws::Map<Aws::String, AttributeValueUpdate>>
108 void SetAttributeUpdates(AttributeUpdatesT&& value) {
109 m_attributeUpdatesHasBeenSet = true;
110 m_attributeUpdates = std::forward<AttributeUpdatesT>(value);
111 }
112 template <typename AttributeUpdatesT = Aws::Map<Aws::String, AttributeValueUpdate>>
113 UpdateItemRequest& WithAttributeUpdates(AttributeUpdatesT&& value) {
114 SetAttributeUpdates(std::forward<AttributeUpdatesT>(value));
115 return *this;
116 }
117 template <typename AttributeUpdatesKeyT = Aws::String, typename AttributeUpdatesValueT = AttributeValueUpdate>
118 UpdateItemRequest& AddAttributeUpdates(AttributeUpdatesKeyT&& key, AttributeUpdatesValueT&& value) {
119 m_attributeUpdatesHasBeenSet = true;
120 m_attributeUpdates.emplace(std::forward<AttributeUpdatesKeyT>(key), std::forward<AttributeUpdatesValueT>(value));
121 return *this;
122 }
124
126
132 inline const Aws::Map<Aws::String, ExpectedAttributeValue>& GetExpected() const { return m_expected; }
133 inline bool ExpectedHasBeenSet() const { return m_expectedHasBeenSet; }
134 template <typename ExpectedT = Aws::Map<Aws::String, ExpectedAttributeValue>>
135 void SetExpected(ExpectedT&& value) {
136 m_expectedHasBeenSet = true;
137 m_expected = std::forward<ExpectedT>(value);
138 }
139 template <typename ExpectedT = Aws::Map<Aws::String, ExpectedAttributeValue>>
140 UpdateItemRequest& WithExpected(ExpectedT&& value) {
141 SetExpected(std::forward<ExpectedT>(value));
142 return *this;
143 }
144 template <typename ExpectedKeyT = Aws::String, typename ExpectedValueT = ExpectedAttributeValue>
145 UpdateItemRequest& AddExpected(ExpectedKeyT&& key, ExpectedValueT&& value) {
146 m_expectedHasBeenSet = true;
147 m_expected.emplace(std::forward<ExpectedKeyT>(key), std::forward<ExpectedValueT>(value));
148 return *this;
149 }
151
153
159 inline ConditionalOperator GetConditionalOperator() const { return m_conditionalOperator; }
160 inline bool ConditionalOperatorHasBeenSet() const { return m_conditionalOperatorHasBeenSet; }
162 m_conditionalOperatorHasBeenSet = true;
163 m_conditionalOperator = value;
164 }
167 return *this;
168 }
170
172
190 inline ReturnValue GetReturnValues() const { return m_returnValues; }
191 inline bool ReturnValuesHasBeenSet() const { return m_returnValuesHasBeenSet; }
192 inline void SetReturnValues(ReturnValue value) {
193 m_returnValuesHasBeenSet = true;
194 m_returnValues = value;
195 }
197 SetReturnValues(value);
198 return *this;
199 }
201
203
204 inline ReturnConsumedCapacity GetReturnConsumedCapacity() const { return m_returnConsumedCapacity; }
205 inline bool ReturnConsumedCapacityHasBeenSet() const { return m_returnConsumedCapacityHasBeenSet; }
207 m_returnConsumedCapacityHasBeenSet = true;
208 m_returnConsumedCapacity = value;
209 }
212 return *this;
213 }
215
217
223 inline ReturnItemCollectionMetrics GetReturnItemCollectionMetrics() const { return m_returnItemCollectionMetrics; }
224 inline bool ReturnItemCollectionMetricsHasBeenSet() const { return m_returnItemCollectionMetricsHasBeenSet; }
226 m_returnItemCollectionMetricsHasBeenSet = true;
227 m_returnItemCollectionMetrics = value;
228 }
231 return *this;
232 }
234
236
296 inline const Aws::String& GetUpdateExpression() const { return m_updateExpression; }
297 inline bool UpdateExpressionHasBeenSet() const { return m_updateExpressionHasBeenSet; }
298 template <typename UpdateExpressionT = Aws::String>
299 void SetUpdateExpression(UpdateExpressionT&& value) {
300 m_updateExpressionHasBeenSet = true;
301 m_updateExpression = std::forward<UpdateExpressionT>(value);
302 }
303 template <typename UpdateExpressionT = Aws::String>
304 UpdateItemRequest& WithUpdateExpression(UpdateExpressionT&& value) {
305 SetUpdateExpression(std::forward<UpdateExpressionT>(value));
306 return *this;
307 }
309
311
323 inline const Aws::String& GetConditionExpression() const { return m_conditionExpression; }
324 inline bool ConditionExpressionHasBeenSet() const { return m_conditionExpressionHasBeenSet; }
325 template <typename ConditionExpressionT = Aws::String>
326 void SetConditionExpression(ConditionExpressionT&& value) {
327 m_conditionExpressionHasBeenSet = true;
328 m_conditionExpression = std::forward<ConditionExpressionT>(value);
329 }
330 template <typename ConditionExpressionT = Aws::String>
331 UpdateItemRequest& WithConditionExpression(ConditionExpressionT&& value) {
332 SetConditionExpression(std::forward<ConditionExpressionT>(value));
333 return *this;
334 }
336
338
363 inline const Aws::Map<Aws::String, Aws::String>& GetExpressionAttributeNames() const { return m_expressionAttributeNames; }
364 inline bool ExpressionAttributeNamesHasBeenSet() const { return m_expressionAttributeNamesHasBeenSet; }
365 template <typename ExpressionAttributeNamesT = Aws::Map<Aws::String, Aws::String>>
366 void SetExpressionAttributeNames(ExpressionAttributeNamesT&& value) {
367 m_expressionAttributeNamesHasBeenSet = true;
368 m_expressionAttributeNames = std::forward<ExpressionAttributeNamesT>(value);
369 }
370 template <typename ExpressionAttributeNamesT = Aws::Map<Aws::String, Aws::String>>
371 UpdateItemRequest& WithExpressionAttributeNames(ExpressionAttributeNamesT&& value) {
372 SetExpressionAttributeNames(std::forward<ExpressionAttributeNamesT>(value));
373 return *this;
374 }
375 template <typename ExpressionAttributeNamesKeyT = Aws::String, typename ExpressionAttributeNamesValueT = Aws::String>
376 UpdateItemRequest& AddExpressionAttributeNames(ExpressionAttributeNamesKeyT&& key, ExpressionAttributeNamesValueT&& value) {
377 m_expressionAttributeNamesHasBeenSet = true;
378 m_expressionAttributeNames.emplace(std::forward<ExpressionAttributeNamesKeyT>(key),
379 std::forward<ExpressionAttributeNamesValueT>(value));
380 return *this;
381 }
383
385
400 inline const Aws::Map<Aws::String, AttributeValue>& GetExpressionAttributeValues() const { return m_expressionAttributeValues; }
401 inline bool ExpressionAttributeValuesHasBeenSet() const { return m_expressionAttributeValuesHasBeenSet; }
402 template <typename ExpressionAttributeValuesT = Aws::Map<Aws::String, AttributeValue>>
403 void SetExpressionAttributeValues(ExpressionAttributeValuesT&& value) {
404 m_expressionAttributeValuesHasBeenSet = true;
405 m_expressionAttributeValues = std::forward<ExpressionAttributeValuesT>(value);
406 }
407 template <typename ExpressionAttributeValuesT = Aws::Map<Aws::String, AttributeValue>>
408 UpdateItemRequest& WithExpressionAttributeValues(ExpressionAttributeValuesT&& value) {
409 SetExpressionAttributeValues(std::forward<ExpressionAttributeValuesT>(value));
410 return *this;
411 }
412 template <typename ExpressionAttributeValuesKeyT = Aws::String, typename ExpressionAttributeValuesValueT = AttributeValue>
413 UpdateItemRequest& AddExpressionAttributeValues(ExpressionAttributeValuesKeyT&& key, ExpressionAttributeValuesValueT&& value) {
414 m_expressionAttributeValuesHasBeenSet = true;
415 m_expressionAttributeValues.emplace(std::forward<ExpressionAttributeValuesKeyT>(key),
416 std::forward<ExpressionAttributeValuesValueT>(value));
417 return *this;
418 }
420
422
430 return m_returnValuesOnConditionCheckFailure;
431 }
432 inline bool ReturnValuesOnConditionCheckFailureHasBeenSet() const { return m_returnValuesOnConditionCheckFailureHasBeenSet; }
434 m_returnValuesOnConditionCheckFailureHasBeenSet = true;
435 m_returnValuesOnConditionCheckFailure = value;
436 }
439 return *this;
440 }
442 private:
443 Aws::String m_tableName;
444
446
448
450
452
453 ReturnValue m_returnValues{ReturnValue::NOT_SET};
454
456
458
459 Aws::String m_updateExpression;
460
461 Aws::String m_conditionExpression;
462
463 Aws::Map<Aws::String, Aws::String> m_expressionAttributeNames;
464
465 Aws::Map<Aws::String, AttributeValue> m_expressionAttributeValues;
466
468 bool m_tableNameHasBeenSet = false;
469 bool m_keyHasBeenSet = false;
470 bool m_attributeUpdatesHasBeenSet = false;
471 bool m_expectedHasBeenSet = false;
472 bool m_conditionalOperatorHasBeenSet = false;
473 bool m_returnValuesHasBeenSet = false;
474 bool m_returnConsumedCapacityHasBeenSet = false;
475 bool m_returnItemCollectionMetricsHasBeenSet = false;
476 bool m_updateExpressionHasBeenSet = false;
477 bool m_conditionExpressionHasBeenSet = false;
478 bool m_expressionAttributeNamesHasBeenSet = false;
479 bool m_expressionAttributeValuesHasBeenSet = false;
480 bool m_returnValuesOnConditionCheckFailureHasBeenSet = false;
481};
482
483} // namespace Model
484} // namespace DynamoDB
485} // namespace Aws
Aws::Endpoint::EndpointParameters EndpointParameters
UpdateItemRequest & WithReturnItemCollectionMetrics(ReturnItemCollectionMetrics value)
void SetAttributeUpdates(AttributeUpdatesT &&value)
UpdateItemRequest & WithUpdateExpression(UpdateExpressionT &&value)
const Aws::String & GetConditionExpression() const
UpdateItemRequest & WithExpected(ExpectedT &&value)
UpdateItemRequest & AddExpressionAttributeValues(ExpressionAttributeValuesKeyT &&key, ExpressionAttributeValuesValueT &&value)
virtual const char * GetServiceRequestName() const override
const Aws::Map< Aws::String, AttributeValueUpdate > & GetAttributeUpdates() const
UpdateItemRequest & WithReturnConsumedCapacity(ReturnConsumedCapacity value)
ReturnValuesOnConditionCheckFailure GetReturnValuesOnConditionCheckFailure() const
void SetReturnConsumedCapacity(ReturnConsumedCapacity value)
void SetConditionExpression(ConditionExpressionT &&value)
UpdateItemRequest & AddKey(KeyKeyT &&key, KeyValueT &&value)
UpdateItemRequest & WithTableName(TableNameT &&value)
UpdateItemRequest & AddExpressionAttributeNames(ExpressionAttributeNamesKeyT &&key, ExpressionAttributeNamesValueT &&value)
void SetConditionalOperator(ConditionalOperator value)
AWS_DYNAMODB_API UpdateItemRequest()=default
void SetExpressionAttributeNames(ExpressionAttributeNamesT &&value)
const Aws::Map< Aws::String, Aws::String > & GetExpressionAttributeNames() const
AWS_DYNAMODB_API EndpointParameters GetEndpointContextParams() const override
const Aws::String & GetUpdateExpression() const
UpdateItemRequest & WithConditionExpression(ConditionExpressionT &&value)
UpdateItemRequest & WithExpressionAttributeValues(ExpressionAttributeValuesT &&value)
AWS_DYNAMODB_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
UpdateItemRequest & WithReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure value)
const Aws::Map< Aws::String, ExpectedAttributeValue > & GetExpected() const
void SetReturnItemCollectionMetrics(ReturnItemCollectionMetrics value)
const Aws::Map< Aws::String, AttributeValue > & GetExpressionAttributeValues() const
AWS_DYNAMODB_API Aws::String SerializePayload() const override
ReturnItemCollectionMetrics GetReturnItemCollectionMetrics() const
UpdateItemRequest & AddExpected(ExpectedKeyT &&key, ExpectedValueT &&value)
void SetExpressionAttributeValues(ExpressionAttributeValuesT &&value)
UpdateItemRequest & WithConditionalOperator(ConditionalOperator value)
ReturnConsumedCapacity GetReturnConsumedCapacity() const
UpdateItemRequest & AddAttributeUpdates(AttributeUpdatesKeyT &&key, AttributeUpdatesValueT &&value)
void SetUpdateExpression(UpdateExpressionT &&value)
ConditionalOperator GetConditionalOperator() const
UpdateItemRequest & WithKey(KeyT &&value)
const Aws::String & GetTableName() const
UpdateItemRequest & WithExpressionAttributeNames(ExpressionAttributeNamesT &&value)
UpdateItemRequest & WithAttributeUpdates(AttributeUpdatesT &&value)
const Aws::Map< Aws::String, AttributeValue > & GetKey() const
UpdateItemRequest & WithReturnValues(ReturnValue value)
void SetReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure value)
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
std::map< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > > Map
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String