AWS SDK for C++

AWS SDK for C++ Version 1.11.870

Loading...
Searching...
No Matches
PutItemRequest.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/ConditionalOperator.h>
13#include <aws/dynamodb/model/ExpectedAttributeValue.h>
14#include <aws/dynamodb/model/ReturnConsumedCapacity.h>
15#include <aws/dynamodb/model/ReturnItemCollectionMetrics.h>
16#include <aws/dynamodb/model/ReturnValue.h>
17#include <aws/dynamodb/model/ReturnValuesOnConditionCheckFailure.h>
18
19#include <utility>
20
21namespace Aws {
22namespace DynamoDB {
23namespace Model {
24
32 public:
33 AWS_DYNAMODB_API PutItemRequest() = default;
34
35 // Service request name is the Operation name which will send this request out,
36 // each operation should has unique request name, so that we can get operation's name from this request.
37 // Note: this is not true for response, multiple operations may have the same response name,
38 // so we can not get operation's name from response.
39 inline virtual const char* GetServiceRequestName() const override { return "PutItem"; }
40
41 AWS_DYNAMODB_API Aws::String SerializePayload() const override;
42
44
48 AWS_DYNAMODB_API EndpointParameters GetEndpointContextParams() const override;
49
51
55 inline const Aws::String& GetTableName() const { return m_tableName; }
56 inline bool TableNameHasBeenSet() const { return m_tableNameHasBeenSet; }
57 template <typename TableNameT = Aws::String>
58 void SetTableName(TableNameT&& value) {
59 m_tableNameHasBeenSet = true;
60 m_tableName = std::forward<TableNameT>(value);
61 }
62 template <typename TableNameT = Aws::String>
63 PutItemRequest& WithTableName(TableNameT&& value) {
64 SetTableName(std::forward<TableNameT>(value));
65 return *this;
66 }
68
70
94 inline const Aws::Map<Aws::String, AttributeValue>& GetItem() const { return m_item; }
95 inline bool ItemHasBeenSet() const { return m_itemHasBeenSet; }
96 template <typename ItemT = Aws::Map<Aws::String, AttributeValue>>
97 void SetItem(ItemT&& value) {
98 m_itemHasBeenSet = true;
99 m_item = std::forward<ItemT>(value);
100 }
101 template <typename ItemT = Aws::Map<Aws::String, AttributeValue>>
102 PutItemRequest& WithItem(ItemT&& value) {
103 SetItem(std::forward<ItemT>(value));
104 return *this;
105 }
106 template <typename ItemKeyT = Aws::String, typename ItemValueT = AttributeValue>
107 PutItemRequest& AddItem(ItemKeyT&& key, ItemValueT&& value) {
108 m_itemHasBeenSet = true;
109 m_item.emplace(std::forward<ItemKeyT>(key), std::forward<ItemValueT>(value));
110 return *this;
111 }
113
115
121 inline const Aws::Map<Aws::String, ExpectedAttributeValue>& GetExpected() const { return m_expected; }
122 inline bool ExpectedHasBeenSet() const { return m_expectedHasBeenSet; }
123 template <typename ExpectedT = Aws::Map<Aws::String, ExpectedAttributeValue>>
124 void SetExpected(ExpectedT&& value) {
125 m_expectedHasBeenSet = true;
126 m_expected = std::forward<ExpectedT>(value);
127 }
128 template <typename ExpectedT = Aws::Map<Aws::String, ExpectedAttributeValue>>
129 PutItemRequest& WithExpected(ExpectedT&& value) {
130 SetExpected(std::forward<ExpectedT>(value));
131 return *this;
132 }
133 template <typename ExpectedKeyT = Aws::String, typename ExpectedValueT = ExpectedAttributeValue>
134 PutItemRequest& AddExpected(ExpectedKeyT&& key, ExpectedValueT&& value) {
135 m_expectedHasBeenSet = true;
136 m_expected.emplace(std::forward<ExpectedKeyT>(key), std::forward<ExpectedValueT>(value));
137 return *this;
138 }
140
142
158 inline ReturnValue GetReturnValues() const { return m_returnValues; }
159 inline bool ReturnValuesHasBeenSet() const { return m_returnValuesHasBeenSet; }
160 inline void SetReturnValues(ReturnValue value) {
161 m_returnValuesHasBeenSet = true;
162 m_returnValues = value;
163 }
165 SetReturnValues(value);
166 return *this;
167 }
169
171
172 inline ReturnConsumedCapacity GetReturnConsumedCapacity() const { return m_returnConsumedCapacity; }
173 inline bool ReturnConsumedCapacityHasBeenSet() const { return m_returnConsumedCapacityHasBeenSet; }
175 m_returnConsumedCapacityHasBeenSet = true;
176 m_returnConsumedCapacity = value;
177 }
180 return *this;
181 }
183
185
191 inline ReturnItemCollectionMetrics GetReturnItemCollectionMetrics() const { return m_returnItemCollectionMetrics; }
192 inline bool ReturnItemCollectionMetricsHasBeenSet() const { return m_returnItemCollectionMetricsHasBeenSet; }
194 m_returnItemCollectionMetricsHasBeenSet = true;
195 m_returnItemCollectionMetrics = value;
196 }
199 return *this;
200 }
202
204
210 inline ConditionalOperator GetConditionalOperator() const { return m_conditionalOperator; }
211 inline bool ConditionalOperatorHasBeenSet() const { return m_conditionalOperatorHasBeenSet; }
213 m_conditionalOperatorHasBeenSet = true;
214 m_conditionalOperator = value;
215 }
218 return *this;
219 }
221
223
235 inline const Aws::String& GetConditionExpression() const { return m_conditionExpression; }
236 inline bool ConditionExpressionHasBeenSet() const { return m_conditionExpressionHasBeenSet; }
237 template <typename ConditionExpressionT = Aws::String>
238 void SetConditionExpression(ConditionExpressionT&& value) {
239 m_conditionExpressionHasBeenSet = true;
240 m_conditionExpression = std::forward<ConditionExpressionT>(value);
241 }
242 template <typename ConditionExpressionT = Aws::String>
243 PutItemRequest& WithConditionExpression(ConditionExpressionT&& value) {
244 SetConditionExpression(std::forward<ConditionExpressionT>(value));
245 return *this;
246 }
248
250
275 inline const Aws::Map<Aws::String, Aws::String>& GetExpressionAttributeNames() const { return m_expressionAttributeNames; }
276 inline bool ExpressionAttributeNamesHasBeenSet() const { return m_expressionAttributeNamesHasBeenSet; }
277 template <typename ExpressionAttributeNamesT = Aws::Map<Aws::String, Aws::String>>
278 void SetExpressionAttributeNames(ExpressionAttributeNamesT&& value) {
279 m_expressionAttributeNamesHasBeenSet = true;
280 m_expressionAttributeNames = std::forward<ExpressionAttributeNamesT>(value);
281 }
282 template <typename ExpressionAttributeNamesT = Aws::Map<Aws::String, Aws::String>>
283 PutItemRequest& WithExpressionAttributeNames(ExpressionAttributeNamesT&& value) {
284 SetExpressionAttributeNames(std::forward<ExpressionAttributeNamesT>(value));
285 return *this;
286 }
287 template <typename ExpressionAttributeNamesKeyT = Aws::String, typename ExpressionAttributeNamesValueT = Aws::String>
288 PutItemRequest& AddExpressionAttributeNames(ExpressionAttributeNamesKeyT&& key, ExpressionAttributeNamesValueT&& value) {
289 m_expressionAttributeNamesHasBeenSet = true;
290 m_expressionAttributeNames.emplace(std::forward<ExpressionAttributeNamesKeyT>(key),
291 std::forward<ExpressionAttributeNamesValueT>(value));
292 return *this;
293 }
295
297
312 inline const Aws::Map<Aws::String, AttributeValue>& GetExpressionAttributeValues() const { return m_expressionAttributeValues; }
313 inline bool ExpressionAttributeValuesHasBeenSet() const { return m_expressionAttributeValuesHasBeenSet; }
314 template <typename ExpressionAttributeValuesT = Aws::Map<Aws::String, AttributeValue>>
315 void SetExpressionAttributeValues(ExpressionAttributeValuesT&& value) {
316 m_expressionAttributeValuesHasBeenSet = true;
317 m_expressionAttributeValues = std::forward<ExpressionAttributeValuesT>(value);
318 }
319 template <typename ExpressionAttributeValuesT = Aws::Map<Aws::String, AttributeValue>>
320 PutItemRequest& WithExpressionAttributeValues(ExpressionAttributeValuesT&& value) {
321 SetExpressionAttributeValues(std::forward<ExpressionAttributeValuesT>(value));
322 return *this;
323 }
324 template <typename ExpressionAttributeValuesKeyT = Aws::String, typename ExpressionAttributeValuesValueT = AttributeValue>
325 PutItemRequest& AddExpressionAttributeValues(ExpressionAttributeValuesKeyT&& key, ExpressionAttributeValuesValueT&& value) {
326 m_expressionAttributeValuesHasBeenSet = true;
327 m_expressionAttributeValues.emplace(std::forward<ExpressionAttributeValuesKeyT>(key),
328 std::forward<ExpressionAttributeValuesValueT>(value));
329 return *this;
330 }
332
334
342 return m_returnValuesOnConditionCheckFailure;
343 }
344 inline bool ReturnValuesOnConditionCheckFailureHasBeenSet() const { return m_returnValuesOnConditionCheckFailureHasBeenSet; }
346 m_returnValuesOnConditionCheckFailureHasBeenSet = true;
347 m_returnValuesOnConditionCheckFailure = value;
348 }
351 return *this;
352 }
354 private:
355 Aws::String m_tableName;
356
358
360
361 ReturnValue m_returnValues{ReturnValue::NOT_SET};
362
364
366
368
369 Aws::String m_conditionExpression;
370
371 Aws::Map<Aws::String, Aws::String> m_expressionAttributeNames;
372
373 Aws::Map<Aws::String, AttributeValue> m_expressionAttributeValues;
374
376 bool m_tableNameHasBeenSet = false;
377 bool m_itemHasBeenSet = false;
378 bool m_expectedHasBeenSet = false;
379 bool m_returnValuesHasBeenSet = false;
380 bool m_returnConsumedCapacityHasBeenSet = false;
381 bool m_returnItemCollectionMetricsHasBeenSet = false;
382 bool m_conditionalOperatorHasBeenSet = false;
383 bool m_conditionExpressionHasBeenSet = false;
384 bool m_expressionAttributeNamesHasBeenSet = false;
385 bool m_expressionAttributeValuesHasBeenSet = false;
386 bool m_returnValuesOnConditionCheckFailureHasBeenSet = false;
387};
388
389} // namespace Model
390} // namespace DynamoDB
391} // namespace Aws
Aws::Endpoint::EndpointParameters EndpointParameters
void SetReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure value)
ReturnItemCollectionMetrics GetReturnItemCollectionMetrics() const
PutItemRequest & WithReturnItemCollectionMetrics(ReturnItemCollectionMetrics value)
const Aws::Map< Aws::String, Aws::String > & GetExpressionAttributeNames() const
void SetReturnConsumedCapacity(ReturnConsumedCapacity value)
PutItemRequest & WithExpressionAttributeValues(ExpressionAttributeValuesT &&value)
const Aws::String & GetConditionExpression() const
PutItemRequest & WithConditionExpression(ConditionExpressionT &&value)
const Aws::String & GetTableName() const
PutItemRequest & AddExpressionAttributeValues(ExpressionAttributeValuesKeyT &&key, ExpressionAttributeValuesValueT &&value)
PutItemRequest & WithConditionalOperator(ConditionalOperator value)
PutItemRequest & WithTableName(TableNameT &&value)
void SetReturnValues(ReturnValue value)
AWS_DYNAMODB_API PutItemRequest()=default
PutItemRequest & WithReturnConsumedCapacity(ReturnConsumedCapacity value)
void SetExpressionAttributeNames(ExpressionAttributeNamesT &&value)
PutItemRequest & WithReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure value)
PutItemRequest & AddItem(ItemKeyT &&key, ItemValueT &&value)
const Aws::Map< Aws::String, AttributeValue > & GetExpressionAttributeValues() const
void SetExpected(ExpectedT &&value)
void SetExpressionAttributeValues(ExpressionAttributeValuesT &&value)
ReturnConsumedCapacity GetReturnConsumedCapacity() const
void SetReturnItemCollectionMetrics(ReturnItemCollectionMetrics value)
AWS_DYNAMODB_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
PutItemRequest & WithItem(ItemT &&value)
PutItemRequest & AddExpected(ExpectedKeyT &&key, ExpectedValueT &&value)
void SetConditionalOperator(ConditionalOperator value)
AWS_DYNAMODB_API Aws::String SerializePayload() const override
bool ReturnValuesOnConditionCheckFailureHasBeenSet() const
const Aws::Map< Aws::String, ExpectedAttributeValue > & GetExpected() const
PutItemRequest & WithExpressionAttributeNames(ExpressionAttributeNamesT &&value)
AWS_DYNAMODB_API EndpointParameters GetEndpointContextParams() const override
ConditionalOperator GetConditionalOperator() const
virtual const char * GetServiceRequestName() const override
const Aws::Map< Aws::String, AttributeValue > & GetItem() const
PutItemRequest & WithExpected(ExpectedT &&value)
PutItemRequest & WithReturnValues(ReturnValue value)
PutItemRequest & AddExpressionAttributeNames(ExpressionAttributeNamesKeyT &&key, ExpressionAttributeNamesValueT &&value)
void SetConditionExpression(ConditionExpressionT &&value)
void SetTableName(TableNameT &&value)
ReturnValuesOnConditionCheckFailure GetReturnValuesOnConditionCheckFailure() const
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