AWS SDK for C++

AWS SDK for C++ Version 1.11.743

Loading...
Searching...
No Matches
DeleteItemRequest.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 DeleteItemRequest() = 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 "DeleteItem"; }
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 DeleteItemRequest& WithTableName(TableNameT&& value) {
64 SetTableName(std::forward<TableNameT>(value));
65 return *this;
66 }
68
70
77 inline const Aws::Map<Aws::String, AttributeValue>& GetKey() const { return m_key; }
78 inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
79 template <typename KeyT = Aws::Map<Aws::String, AttributeValue>>
80 void SetKey(KeyT&& value) {
81 m_keyHasBeenSet = true;
82 m_key = std::forward<KeyT>(value);
83 }
84 template <typename KeyT = Aws::Map<Aws::String, AttributeValue>>
85 DeleteItemRequest& WithKey(KeyT&& value) {
86 SetKey(std::forward<KeyT>(value));
87 return *this;
88 }
89 template <typename KeyKeyT = Aws::String, typename KeyValueT = AttributeValue>
90 DeleteItemRequest& AddKey(KeyKeyT&& key, KeyValueT&& value) {
91 m_keyHasBeenSet = true;
92 m_key.emplace(std::forward<KeyKeyT>(key), std::forward<KeyValueT>(value));
93 return *this;
94 }
96
98
104 inline const Aws::Map<Aws::String, ExpectedAttributeValue>& GetExpected() const { return m_expected; }
105 inline bool ExpectedHasBeenSet() const { return m_expectedHasBeenSet; }
106 template <typename ExpectedT = Aws::Map<Aws::String, ExpectedAttributeValue>>
107 void SetExpected(ExpectedT&& value) {
108 m_expectedHasBeenSet = true;
109 m_expected = std::forward<ExpectedT>(value);
110 }
111 template <typename ExpectedT = Aws::Map<Aws::String, ExpectedAttributeValue>>
112 DeleteItemRequest& WithExpected(ExpectedT&& value) {
113 SetExpected(std::forward<ExpectedT>(value));
114 return *this;
115 }
116 template <typename ExpectedKeyT = Aws::String, typename ExpectedValueT = ExpectedAttributeValue>
117 DeleteItemRequest& AddExpected(ExpectedKeyT&& key, ExpectedValueT&& value) {
118 m_expectedHasBeenSet = true;
119 m_expected.emplace(std::forward<ExpectedKeyT>(key), std::forward<ExpectedValueT>(value));
120 return *this;
121 }
123
125
131 inline ConditionalOperator GetConditionalOperator() const { return m_conditionalOperator; }
132 inline bool ConditionalOperatorHasBeenSet() const { return m_conditionalOperatorHasBeenSet; }
134 m_conditionalOperatorHasBeenSet = true;
135 m_conditionalOperator = value;
136 }
139 return *this;
140 }
142
144
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
216 inline const Aws::String& GetConditionExpression() const { return m_conditionExpression; }
217 inline bool ConditionExpressionHasBeenSet() const { return m_conditionExpressionHasBeenSet; }
218 template <typename ConditionExpressionT = Aws::String>
219 void SetConditionExpression(ConditionExpressionT&& value) {
220 m_conditionExpressionHasBeenSet = true;
221 m_conditionExpression = std::forward<ConditionExpressionT>(value);
222 }
223 template <typename ConditionExpressionT = Aws::String>
224 DeleteItemRequest& WithConditionExpression(ConditionExpressionT&& value) {
225 SetConditionExpression(std::forward<ConditionExpressionT>(value));
226 return *this;
227 }
229
231
256 inline const Aws::Map<Aws::String, Aws::String>& GetExpressionAttributeNames() const { return m_expressionAttributeNames; }
257 inline bool ExpressionAttributeNamesHasBeenSet() const { return m_expressionAttributeNamesHasBeenSet; }
258 template <typename ExpressionAttributeNamesT = Aws::Map<Aws::String, Aws::String>>
259 void SetExpressionAttributeNames(ExpressionAttributeNamesT&& value) {
260 m_expressionAttributeNamesHasBeenSet = true;
261 m_expressionAttributeNames = std::forward<ExpressionAttributeNamesT>(value);
262 }
263 template <typename ExpressionAttributeNamesT = Aws::Map<Aws::String, Aws::String>>
264 DeleteItemRequest& WithExpressionAttributeNames(ExpressionAttributeNamesT&& value) {
265 SetExpressionAttributeNames(std::forward<ExpressionAttributeNamesT>(value));
266 return *this;
267 }
268 template <typename ExpressionAttributeNamesKeyT = Aws::String, typename ExpressionAttributeNamesValueT = Aws::String>
269 DeleteItemRequest& AddExpressionAttributeNames(ExpressionAttributeNamesKeyT&& key, ExpressionAttributeNamesValueT&& value) {
270 m_expressionAttributeNamesHasBeenSet = true;
271 m_expressionAttributeNames.emplace(std::forward<ExpressionAttributeNamesKeyT>(key),
272 std::forward<ExpressionAttributeNamesValueT>(value));
273 return *this;
274 }
276
278
293 inline const Aws::Map<Aws::String, AttributeValue>& GetExpressionAttributeValues() const { return m_expressionAttributeValues; }
294 inline bool ExpressionAttributeValuesHasBeenSet() const { return m_expressionAttributeValuesHasBeenSet; }
295 template <typename ExpressionAttributeValuesT = Aws::Map<Aws::String, AttributeValue>>
296 void SetExpressionAttributeValues(ExpressionAttributeValuesT&& value) {
297 m_expressionAttributeValuesHasBeenSet = true;
298 m_expressionAttributeValues = std::forward<ExpressionAttributeValuesT>(value);
299 }
300 template <typename ExpressionAttributeValuesT = Aws::Map<Aws::String, AttributeValue>>
301 DeleteItemRequest& WithExpressionAttributeValues(ExpressionAttributeValuesT&& value) {
302 SetExpressionAttributeValues(std::forward<ExpressionAttributeValuesT>(value));
303 return *this;
304 }
305 template <typename ExpressionAttributeValuesKeyT = Aws::String, typename ExpressionAttributeValuesValueT = AttributeValue>
306 DeleteItemRequest& AddExpressionAttributeValues(ExpressionAttributeValuesKeyT&& key, ExpressionAttributeValuesValueT&& value) {
307 m_expressionAttributeValuesHasBeenSet = true;
308 m_expressionAttributeValues.emplace(std::forward<ExpressionAttributeValuesKeyT>(key),
309 std::forward<ExpressionAttributeValuesValueT>(value));
310 return *this;
311 }
313
315
323 return m_returnValuesOnConditionCheckFailure;
324 }
325 inline bool ReturnValuesOnConditionCheckFailureHasBeenSet() const { return m_returnValuesOnConditionCheckFailureHasBeenSet; }
327 m_returnValuesOnConditionCheckFailureHasBeenSet = true;
328 m_returnValuesOnConditionCheckFailure = value;
329 }
332 return *this;
333 }
335 private:
336 Aws::String m_tableName;
337
339
341
343
344 ReturnValue m_returnValues{ReturnValue::NOT_SET};
345
347
349
350 Aws::String m_conditionExpression;
351
352 Aws::Map<Aws::String, Aws::String> m_expressionAttributeNames;
353
354 Aws::Map<Aws::String, AttributeValue> m_expressionAttributeValues;
355
357 bool m_tableNameHasBeenSet = false;
358 bool m_keyHasBeenSet = false;
359 bool m_expectedHasBeenSet = false;
360 bool m_conditionalOperatorHasBeenSet = false;
361 bool m_returnValuesHasBeenSet = false;
362 bool m_returnConsumedCapacityHasBeenSet = false;
363 bool m_returnItemCollectionMetricsHasBeenSet = false;
364 bool m_conditionExpressionHasBeenSet = false;
365 bool m_expressionAttributeNamesHasBeenSet = false;
366 bool m_expressionAttributeValuesHasBeenSet = false;
367 bool m_returnValuesOnConditionCheckFailureHasBeenSet = false;
368};
369
370} // namespace Model
371} // namespace DynamoDB
372} // namespace Aws
Aws::Endpoint::EndpointParameters EndpointParameters
DeleteItemRequest & WithExpected(ExpectedT &&value)
DeleteItemRequest & WithReturnItemCollectionMetrics(ReturnItemCollectionMetrics value)
const Aws::Map< Aws::String, AttributeValue > & GetKey() const
DeleteItemRequest & WithReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure value)
void SetExpressionAttributeValues(ExpressionAttributeValuesT &&value)
AWS_DYNAMODB_API EndpointParameters GetEndpointContextParams() const override
void SetReturnConsumedCapacity(ReturnConsumedCapacity value)
const Aws::Map< Aws::String, ExpectedAttributeValue > & GetExpected() const
virtual const char * GetServiceRequestName() const override
DeleteItemRequest & WithTableName(TableNameT &&value)
DeleteItemRequest & WithExpressionAttributeNames(ExpressionAttributeNamesT &&value)
ReturnConsumedCapacity GetReturnConsumedCapacity() const
DeleteItemRequest & WithReturnConsumedCapacity(ReturnConsumedCapacity value)
AWS_DYNAMODB_API Aws::String SerializePayload() const override
DeleteItemRequest & AddExpressionAttributeNames(ExpressionAttributeNamesKeyT &&key, ExpressionAttributeNamesValueT &&value)
DeleteItemRequest & WithKey(KeyT &&value)
DeleteItemRequest & AddKey(KeyKeyT &&key, KeyValueT &&value)
void SetConditionalOperator(ConditionalOperator value)
DeleteItemRequest & AddExpected(ExpectedKeyT &&key, ExpectedValueT &&value)
ConditionalOperator GetConditionalOperator() const
const Aws::String & GetTableName() const
ReturnValuesOnConditionCheckFailure GetReturnValuesOnConditionCheckFailure() const
DeleteItemRequest & WithConditionalOperator(ConditionalOperator value)
void SetReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure value)
DeleteItemRequest & AddExpressionAttributeValues(ExpressionAttributeValuesKeyT &&key, ExpressionAttributeValuesValueT &&value)
const Aws::String & GetConditionExpression() const
AWS_DYNAMODB_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
AWS_DYNAMODB_API DeleteItemRequest()=default
const Aws::Map< Aws::String, Aws::String > & GetExpressionAttributeNames() const
void SetReturnItemCollectionMetrics(ReturnItemCollectionMetrics value)
const Aws::Map< Aws::String, AttributeValue > & GetExpressionAttributeValues() const
DeleteItemRequest & WithReturnValues(ReturnValue value)
ReturnItemCollectionMetrics GetReturnItemCollectionMetrics() const
DeleteItemRequest & WithConditionExpression(ConditionExpressionT &&value)
void SetExpressionAttributeNames(ExpressionAttributeNamesT &&value)
DeleteItemRequest & WithExpressionAttributeValues(ExpressionAttributeValuesT &&value)
void SetConditionExpression(ConditionExpressionT &&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