AWS SDK for C++

AWS SDK for C++ Version 1.11.606

Loading...
Searching...
No Matches
DeleteItemRequest.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/ExpectedAttributeValue.h>
18#include <utility>
19
20namespace Aws
21{
22namespace DynamoDB
23{
24namespace Model
25{
26
34 {
35 public:
36 AWS_DYNAMODB_API DeleteItemRequest() = default;
37
38 // Service request name is the Operation name which will send this request out,
39 // each operation should has unique request name, so that we can get operation's name from this request.
40 // Note: this is not true for response, multiple operations may have the same response name,
41 // so we can not get operation's name from response.
42 inline virtual const char* GetServiceRequestName() const override { return "DeleteItem"; }
43
44 AWS_DYNAMODB_API Aws::String SerializePayload() const override;
45
47
51 AWS_DYNAMODB_API EndpointParameters GetEndpointContextParams() const override;
52
54
58 inline const Aws::String& GetTableName() const { return m_tableName; }
59 inline bool TableNameHasBeenSet() const { return m_tableNameHasBeenSet; }
60 template<typename TableNameT = Aws::String>
61 void SetTableName(TableNameT&& value) { m_tableNameHasBeenSet = true; m_tableName = std::forward<TableNameT>(value); }
62 template<typename TableNameT = Aws::String>
63 DeleteItemRequest& WithTableName(TableNameT&& value) { SetTableName(std::forward<TableNameT>(value)); return *this;}
65
67
74 inline const Aws::Map<Aws::String, AttributeValue>& GetKey() const { return m_key; }
75 inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
76 template<typename KeyT = Aws::Map<Aws::String, AttributeValue>>
77 void SetKey(KeyT&& value) { m_keyHasBeenSet = true; m_key = std::forward<KeyT>(value); }
78 template<typename KeyT = Aws::Map<Aws::String, AttributeValue>>
79 DeleteItemRequest& WithKey(KeyT&& value) { SetKey(std::forward<KeyT>(value)); return *this;}
80 template<typename KeyKeyT = Aws::String, typename KeyValueT = AttributeValue>
81 DeleteItemRequest& AddKey(KeyKeyT&& key, KeyValueT&& value) {
82 m_keyHasBeenSet = true; m_key.emplace(std::forward<KeyKeyT>(key), std::forward<KeyValueT>(value)); return *this;
83 }
85
87
93 inline const Aws::Map<Aws::String, ExpectedAttributeValue>& GetExpected() const { return m_expected; }
94 inline bool ExpectedHasBeenSet() const { return m_expectedHasBeenSet; }
95 template<typename ExpectedT = Aws::Map<Aws::String, ExpectedAttributeValue>>
96 void SetExpected(ExpectedT&& value) { m_expectedHasBeenSet = true; m_expected = std::forward<ExpectedT>(value); }
97 template<typename ExpectedT = Aws::Map<Aws::String, ExpectedAttributeValue>>
98 DeleteItemRequest& WithExpected(ExpectedT&& value) { SetExpected(std::forward<ExpectedT>(value)); return *this;}
99 template<typename ExpectedKeyT = Aws::String, typename ExpectedValueT = ExpectedAttributeValue>
100 DeleteItemRequest& AddExpected(ExpectedKeyT&& key, ExpectedValueT&& value) {
101 m_expectedHasBeenSet = true; m_expected.emplace(std::forward<ExpectedKeyT>(key), std::forward<ExpectedValueT>(value)); return *this;
102 }
104
106
112 inline ConditionalOperator GetConditionalOperator() const { return m_conditionalOperator; }
113 inline bool ConditionalOperatorHasBeenSet() const { return m_conditionalOperatorHasBeenSet; }
114 inline void SetConditionalOperator(ConditionalOperator value) { m_conditionalOperatorHasBeenSet = true; m_conditionalOperator = value; }
117
119
133 inline ReturnValue GetReturnValues() const { return m_returnValues; }
134 inline bool ReturnValuesHasBeenSet() const { return m_returnValuesHasBeenSet; }
135 inline void SetReturnValues(ReturnValue value) { m_returnValuesHasBeenSet = true; m_returnValues = value; }
136 inline DeleteItemRequest& WithReturnValues(ReturnValue value) { SetReturnValues(value); return *this;}
138
140
141 inline ReturnConsumedCapacity GetReturnConsumedCapacity() const { return m_returnConsumedCapacity; }
142 inline bool ReturnConsumedCapacityHasBeenSet() const { return m_returnConsumedCapacityHasBeenSet; }
143 inline void SetReturnConsumedCapacity(ReturnConsumedCapacity value) { m_returnConsumedCapacityHasBeenSet = true; m_returnConsumedCapacity = value; }
146
148
154 inline ReturnItemCollectionMetrics GetReturnItemCollectionMetrics() const { return m_returnItemCollectionMetrics; }
155 inline bool ReturnItemCollectionMetricsHasBeenSet() const { return m_returnItemCollectionMetricsHasBeenSet; }
156 inline void SetReturnItemCollectionMetrics(ReturnItemCollectionMetrics value) { m_returnItemCollectionMetricsHasBeenSet = true; m_returnItemCollectionMetrics = value; }
159
161
173 inline const Aws::String& GetConditionExpression() const { return m_conditionExpression; }
174 inline bool ConditionExpressionHasBeenSet() const { return m_conditionExpressionHasBeenSet; }
175 template<typename ConditionExpressionT = Aws::String>
176 void SetConditionExpression(ConditionExpressionT&& value) { m_conditionExpressionHasBeenSet = true; m_conditionExpression = std::forward<ConditionExpressionT>(value); }
177 template<typename ConditionExpressionT = Aws::String>
178 DeleteItemRequest& WithConditionExpression(ConditionExpressionT&& value) { SetConditionExpression(std::forward<ConditionExpressionT>(value)); return *this;}
180
182
207 inline const Aws::Map<Aws::String, Aws::String>& GetExpressionAttributeNames() const { return m_expressionAttributeNames; }
208 inline bool ExpressionAttributeNamesHasBeenSet() const { return m_expressionAttributeNamesHasBeenSet; }
209 template<typename ExpressionAttributeNamesT = Aws::Map<Aws::String, Aws::String>>
210 void SetExpressionAttributeNames(ExpressionAttributeNamesT&& value) { m_expressionAttributeNamesHasBeenSet = true; m_expressionAttributeNames = std::forward<ExpressionAttributeNamesT>(value); }
211 template<typename ExpressionAttributeNamesT = Aws::Map<Aws::String, Aws::String>>
212 DeleteItemRequest& WithExpressionAttributeNames(ExpressionAttributeNamesT&& value) { SetExpressionAttributeNames(std::forward<ExpressionAttributeNamesT>(value)); return *this;}
213 template<typename ExpressionAttributeNamesKeyT = Aws::String, typename ExpressionAttributeNamesValueT = Aws::String>
214 DeleteItemRequest& AddExpressionAttributeNames(ExpressionAttributeNamesKeyT&& key, ExpressionAttributeNamesValueT&& value) {
215 m_expressionAttributeNamesHasBeenSet = true; m_expressionAttributeNames.emplace(std::forward<ExpressionAttributeNamesKeyT>(key), std::forward<ExpressionAttributeNamesValueT>(value)); return *this;
216 }
218
220
235 inline const Aws::Map<Aws::String, AttributeValue>& GetExpressionAttributeValues() const { return m_expressionAttributeValues; }
236 inline bool ExpressionAttributeValuesHasBeenSet() const { return m_expressionAttributeValuesHasBeenSet; }
237 template<typename ExpressionAttributeValuesT = Aws::Map<Aws::String, AttributeValue>>
238 void SetExpressionAttributeValues(ExpressionAttributeValuesT&& value) { m_expressionAttributeValuesHasBeenSet = true; m_expressionAttributeValues = std::forward<ExpressionAttributeValuesT>(value); }
239 template<typename ExpressionAttributeValuesT = Aws::Map<Aws::String, AttributeValue>>
240 DeleteItemRequest& WithExpressionAttributeValues(ExpressionAttributeValuesT&& value) { SetExpressionAttributeValues(std::forward<ExpressionAttributeValuesT>(value)); return *this;}
241 template<typename ExpressionAttributeValuesKeyT = Aws::String, typename ExpressionAttributeValuesValueT = AttributeValue>
242 DeleteItemRequest& AddExpressionAttributeValues(ExpressionAttributeValuesKeyT&& key, ExpressionAttributeValuesValueT&& value) {
243 m_expressionAttributeValuesHasBeenSet = true; m_expressionAttributeValues.emplace(std::forward<ExpressionAttributeValuesKeyT>(key), std::forward<ExpressionAttributeValuesValueT>(value)); return *this;
244 }
246
248
255 inline ReturnValuesOnConditionCheckFailure GetReturnValuesOnConditionCheckFailure() const { return m_returnValuesOnConditionCheckFailure; }
256 inline bool ReturnValuesOnConditionCheckFailureHasBeenSet() const { return m_returnValuesOnConditionCheckFailureHasBeenSet; }
257 inline void SetReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure value) { m_returnValuesOnConditionCheckFailureHasBeenSet = true; m_returnValuesOnConditionCheckFailure = value; }
260 private:
261
262 Aws::String m_tableName;
263 bool m_tableNameHasBeenSet = false;
264
266 bool m_keyHasBeenSet = false;
267
269 bool m_expectedHasBeenSet = false;
270
272 bool m_conditionalOperatorHasBeenSet = false;
273
274 ReturnValue m_returnValues{ReturnValue::NOT_SET};
275 bool m_returnValuesHasBeenSet = false;
276
278 bool m_returnConsumedCapacityHasBeenSet = false;
279
281 bool m_returnItemCollectionMetricsHasBeenSet = false;
282
283 Aws::String m_conditionExpression;
284 bool m_conditionExpressionHasBeenSet = false;
285
286 Aws::Map<Aws::String, Aws::String> m_expressionAttributeNames;
287 bool m_expressionAttributeNamesHasBeenSet = false;
288
289 Aws::Map<Aws::String, AttributeValue> m_expressionAttributeValues;
290 bool m_expressionAttributeValuesHasBeenSet = false;
291
293 bool m_returnValuesOnConditionCheckFailureHasBeenSet = false;
294 };
295
296} // namespace Model
297} // namespace DynamoDB
298} // 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