AWS SDK for C++

AWS SDK for C++ Version 1.11.606

Loading...
Searching...
No Matches
UpdateItemRequest.h
1
6#pragma once
7#include <aws/dynamodb/DynamoDB_EXPORTS.h>
8#include <aws/dynamodb/DynamoDBRequest.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/core/utils/memory/stl/AWSMap.h>
11#include <aws/dynamodb/model/ConditionalOperator.h>
12#include <aws/dynamodb/model/ReturnValue.h>
13#include <aws/dynamodb/model/ReturnConsumedCapacity.h>
14#include <aws/dynamodb/model/ReturnItemCollectionMetrics.h>
15#include <aws/dynamodb/model/ReturnValuesOnConditionCheckFailure.h>
16#include <aws/dynamodb/model/AttributeValue.h>
17#include <aws/dynamodb/model/AttributeValueUpdate.h>
18#include <aws/dynamodb/model/ExpectedAttributeValue.h>
19#include <utility>
20
21namespace Aws
22{
23namespace DynamoDB
24{
25namespace Model
26{
27
35 {
36 public:
37 AWS_DYNAMODB_API UpdateItemRequest() = default;
38
39 // Service request name is the Operation name which will send this request out,
40 // each operation should has unique request name, so that we can get operation's name from this request.
41 // Note: this is not true for response, multiple operations may have the same response name,
42 // so we can not get operation's name from response.
43 inline virtual const char* GetServiceRequestName() const override { return "UpdateItem"; }
44
45 AWS_DYNAMODB_API Aws::String SerializePayload() const override;
46
48
52 AWS_DYNAMODB_API EndpointParameters GetEndpointContextParams() const override;
53
55
59 inline const Aws::String& GetTableName() const { return m_tableName; }
60 inline bool TableNameHasBeenSet() const { return m_tableNameHasBeenSet; }
61 template<typename TableNameT = Aws::String>
62 void SetTableName(TableNameT&& value) { m_tableNameHasBeenSet = true; m_tableName = std::forward<TableNameT>(value); }
63 template<typename TableNameT = Aws::String>
64 UpdateItemRequest& WithTableName(TableNameT&& value) { SetTableName(std::forward<TableNameT>(value)); return *this;}
66
68
75 inline const Aws::Map<Aws::String, AttributeValue>& GetKey() const { return m_key; }
76 inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
77 template<typename KeyT = Aws::Map<Aws::String, AttributeValue>>
78 void SetKey(KeyT&& value) { m_keyHasBeenSet = true; m_key = std::forward<KeyT>(value); }
79 template<typename KeyT = Aws::Map<Aws::String, AttributeValue>>
80 UpdateItemRequest& WithKey(KeyT&& value) { SetKey(std::forward<KeyT>(value)); return *this;}
81 template<typename KeyKeyT = Aws::String, typename KeyValueT = AttributeValue>
82 UpdateItemRequest& AddKey(KeyKeyT&& key, KeyValueT&& value) {
83 m_keyHasBeenSet = true; m_key.emplace(std::forward<KeyKeyT>(key), std::forward<KeyValueT>(value)); return *this;
84 }
86
88
94 inline const Aws::Map<Aws::String, AttributeValueUpdate>& GetAttributeUpdates() const { return m_attributeUpdates; }
95 inline bool AttributeUpdatesHasBeenSet() const { return m_attributeUpdatesHasBeenSet; }
96 template<typename AttributeUpdatesT = Aws::Map<Aws::String, AttributeValueUpdate>>
97 void SetAttributeUpdates(AttributeUpdatesT&& value) { m_attributeUpdatesHasBeenSet = true; m_attributeUpdates = std::forward<AttributeUpdatesT>(value); }
98 template<typename AttributeUpdatesT = Aws::Map<Aws::String, AttributeValueUpdate>>
99 UpdateItemRequest& WithAttributeUpdates(AttributeUpdatesT&& value) { SetAttributeUpdates(std::forward<AttributeUpdatesT>(value)); return *this;}
100 template<typename AttributeUpdatesKeyT = Aws::String, typename AttributeUpdatesValueT = AttributeValueUpdate>
101 UpdateItemRequest& AddAttributeUpdates(AttributeUpdatesKeyT&& key, AttributeUpdatesValueT&& value) {
102 m_attributeUpdatesHasBeenSet = true; m_attributeUpdates.emplace(std::forward<AttributeUpdatesKeyT>(key), std::forward<AttributeUpdatesValueT>(value)); return *this;
103 }
105
107
113 inline const Aws::Map<Aws::String, ExpectedAttributeValue>& GetExpected() const { return m_expected; }
114 inline bool ExpectedHasBeenSet() const { return m_expectedHasBeenSet; }
115 template<typename ExpectedT = Aws::Map<Aws::String, ExpectedAttributeValue>>
116 void SetExpected(ExpectedT&& value) { m_expectedHasBeenSet = true; m_expected = std::forward<ExpectedT>(value); }
117 template<typename ExpectedT = Aws::Map<Aws::String, ExpectedAttributeValue>>
118 UpdateItemRequest& WithExpected(ExpectedT&& value) { SetExpected(std::forward<ExpectedT>(value)); return *this;}
119 template<typename ExpectedKeyT = Aws::String, typename ExpectedValueT = ExpectedAttributeValue>
120 UpdateItemRequest& AddExpected(ExpectedKeyT&& key, ExpectedValueT&& value) {
121 m_expectedHasBeenSet = true; m_expected.emplace(std::forward<ExpectedKeyT>(key), std::forward<ExpectedValueT>(value)); return *this;
122 }
124
126
132 inline ConditionalOperator GetConditionalOperator() const { return m_conditionalOperator; }
133 inline bool ConditionalOperatorHasBeenSet() const { return m_conditionalOperatorHasBeenSet; }
134 inline void SetConditionalOperator(ConditionalOperator value) { m_conditionalOperatorHasBeenSet = true; m_conditionalOperator = value; }
137
139
157 inline ReturnValue GetReturnValues() const { return m_returnValues; }
158 inline bool ReturnValuesHasBeenSet() const { return m_returnValuesHasBeenSet; }
159 inline void SetReturnValues(ReturnValue value) { m_returnValuesHasBeenSet = true; m_returnValues = value; }
160 inline UpdateItemRequest& WithReturnValues(ReturnValue value) { SetReturnValues(value); return *this;}
162
164
165 inline ReturnConsumedCapacity GetReturnConsumedCapacity() const { return m_returnConsumedCapacity; }
166 inline bool ReturnConsumedCapacityHasBeenSet() const { return m_returnConsumedCapacityHasBeenSet; }
167 inline void SetReturnConsumedCapacity(ReturnConsumedCapacity value) { m_returnConsumedCapacityHasBeenSet = true; m_returnConsumedCapacity = value; }
170
172
178 inline ReturnItemCollectionMetrics GetReturnItemCollectionMetrics() const { return m_returnItemCollectionMetrics; }
179 inline bool ReturnItemCollectionMetricsHasBeenSet() const { return m_returnItemCollectionMetricsHasBeenSet; }
180 inline void SetReturnItemCollectionMetrics(ReturnItemCollectionMetrics value) { m_returnItemCollectionMetricsHasBeenSet = true; m_returnItemCollectionMetrics = value; }
183
185
245 inline const Aws::String& GetUpdateExpression() const { return m_updateExpression; }
246 inline bool UpdateExpressionHasBeenSet() const { return m_updateExpressionHasBeenSet; }
247 template<typename UpdateExpressionT = Aws::String>
248 void SetUpdateExpression(UpdateExpressionT&& value) { m_updateExpressionHasBeenSet = true; m_updateExpression = std::forward<UpdateExpressionT>(value); }
249 template<typename UpdateExpressionT = Aws::String>
250 UpdateItemRequest& WithUpdateExpression(UpdateExpressionT&& value) { SetUpdateExpression(std::forward<UpdateExpressionT>(value)); return *this;}
252
254
266 inline const Aws::String& GetConditionExpression() const { return m_conditionExpression; }
267 inline bool ConditionExpressionHasBeenSet() const { return m_conditionExpressionHasBeenSet; }
268 template<typename ConditionExpressionT = Aws::String>
269 void SetConditionExpression(ConditionExpressionT&& value) { m_conditionExpressionHasBeenSet = true; m_conditionExpression = std::forward<ConditionExpressionT>(value); }
270 template<typename ConditionExpressionT = Aws::String>
271 UpdateItemRequest& WithConditionExpression(ConditionExpressionT&& value) { SetConditionExpression(std::forward<ConditionExpressionT>(value)); return *this;}
273
275
300 inline const Aws::Map<Aws::String, Aws::String>& GetExpressionAttributeNames() const { return m_expressionAttributeNames; }
301 inline bool ExpressionAttributeNamesHasBeenSet() const { return m_expressionAttributeNamesHasBeenSet; }
302 template<typename ExpressionAttributeNamesT = Aws::Map<Aws::String, Aws::String>>
303 void SetExpressionAttributeNames(ExpressionAttributeNamesT&& value) { m_expressionAttributeNamesHasBeenSet = true; m_expressionAttributeNames = std::forward<ExpressionAttributeNamesT>(value); }
304 template<typename ExpressionAttributeNamesT = Aws::Map<Aws::String, Aws::String>>
305 UpdateItemRequest& WithExpressionAttributeNames(ExpressionAttributeNamesT&& value) { SetExpressionAttributeNames(std::forward<ExpressionAttributeNamesT>(value)); return *this;}
306 template<typename ExpressionAttributeNamesKeyT = Aws::String, typename ExpressionAttributeNamesValueT = Aws::String>
307 UpdateItemRequest& AddExpressionAttributeNames(ExpressionAttributeNamesKeyT&& key, ExpressionAttributeNamesValueT&& value) {
308 m_expressionAttributeNamesHasBeenSet = true; m_expressionAttributeNames.emplace(std::forward<ExpressionAttributeNamesKeyT>(key), std::forward<ExpressionAttributeNamesValueT>(value)); return *this;
309 }
311
313
328 inline const Aws::Map<Aws::String, AttributeValue>& GetExpressionAttributeValues() const { return m_expressionAttributeValues; }
329 inline bool ExpressionAttributeValuesHasBeenSet() const { return m_expressionAttributeValuesHasBeenSet; }
330 template<typename ExpressionAttributeValuesT = Aws::Map<Aws::String, AttributeValue>>
331 void SetExpressionAttributeValues(ExpressionAttributeValuesT&& value) { m_expressionAttributeValuesHasBeenSet = true; m_expressionAttributeValues = std::forward<ExpressionAttributeValuesT>(value); }
332 template<typename ExpressionAttributeValuesT = Aws::Map<Aws::String, AttributeValue>>
333 UpdateItemRequest& WithExpressionAttributeValues(ExpressionAttributeValuesT&& value) { SetExpressionAttributeValues(std::forward<ExpressionAttributeValuesT>(value)); return *this;}
334 template<typename ExpressionAttributeValuesKeyT = Aws::String, typename ExpressionAttributeValuesValueT = AttributeValue>
335 UpdateItemRequest& AddExpressionAttributeValues(ExpressionAttributeValuesKeyT&& key, ExpressionAttributeValuesValueT&& value) {
336 m_expressionAttributeValuesHasBeenSet = true; m_expressionAttributeValues.emplace(std::forward<ExpressionAttributeValuesKeyT>(key), std::forward<ExpressionAttributeValuesValueT>(value)); return *this;
337 }
339
341
348 inline ReturnValuesOnConditionCheckFailure GetReturnValuesOnConditionCheckFailure() const { return m_returnValuesOnConditionCheckFailure; }
349 inline bool ReturnValuesOnConditionCheckFailureHasBeenSet() const { return m_returnValuesOnConditionCheckFailureHasBeenSet; }
350 inline void SetReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure value) { m_returnValuesOnConditionCheckFailureHasBeenSet = true; m_returnValuesOnConditionCheckFailure = value; }
353 private:
354
355 Aws::String m_tableName;
356 bool m_tableNameHasBeenSet = false;
357
359 bool m_keyHasBeenSet = false;
360
362 bool m_attributeUpdatesHasBeenSet = false;
363
365 bool m_expectedHasBeenSet = false;
366
368 bool m_conditionalOperatorHasBeenSet = false;
369
370 ReturnValue m_returnValues{ReturnValue::NOT_SET};
371 bool m_returnValuesHasBeenSet = false;
372
374 bool m_returnConsumedCapacityHasBeenSet = false;
375
377 bool m_returnItemCollectionMetricsHasBeenSet = false;
378
379 Aws::String m_updateExpression;
380 bool m_updateExpressionHasBeenSet = false;
381
382 Aws::String m_conditionExpression;
383 bool m_conditionExpressionHasBeenSet = false;
384
385 Aws::Map<Aws::String, Aws::String> m_expressionAttributeNames;
386 bool m_expressionAttributeNamesHasBeenSet = false;
387
388 Aws::Map<Aws::String, AttributeValue> m_expressionAttributeValues;
389 bool m_expressionAttributeValuesHasBeenSet = false;
390
392 bool m_returnValuesOnConditionCheckFailureHasBeenSet = false;
393 };
394
395} // namespace Model
396} // namespace DynamoDB
397} // 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