AWS SDK for C++

AWS SDK for C++ Version 1.11.440

Loading...
Searching...
No Matches
DeleteObjectRequest.h
1
6#pragma once
7#include <aws/s3/S3_EXPORTS.h>
8#include <aws/s3/S3Request.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/s3/model/RequestPayer.h>
11#include <aws/core/utils/memory/stl/AWSMap.h>
12#include <utility>
13
14namespace Aws
15{
16namespace Http
17{
18 class URI;
19} //namespace Http
20namespace S3
21{
22namespace Model
23{
24
28 {
29 public:
30 AWS_S3_API DeleteObjectRequest();
31
32 // Service request name is the Operation name which will send this request out,
33 // each operation should has unique request name, so that we can get operation's name from this request.
34 // Note: this is not true for response, multiple operations may have the same response name,
35 // so we can not get operation's name from response.
36 inline virtual const char* GetServiceRequestName() const override { return "DeleteObject"; }
37
38 AWS_S3_API Aws::String SerializePayload() const override;
39
40 AWS_S3_API void AddQueryStringParameters(Aws::Http::URI& uri) const override;
41
43
44 AWS_S3_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override;
48 AWS_S3_API EndpointParameters GetEndpointContextParams() const override;
49
51
84 inline const Aws::String& GetBucket() const{ return m_bucket; }
85 inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
86 inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; }
87 inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); }
88 inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); }
89 inline DeleteObjectRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;}
90 inline DeleteObjectRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;}
91 inline DeleteObjectRequest& WithBucket(const char* value) { SetBucket(value); return *this;}
93
95
98 inline const Aws::String& GetKey() const{ return m_key; }
99 inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
100 inline void SetKey(const Aws::String& value) { m_keyHasBeenSet = true; m_key = value; }
101 inline void SetKey(Aws::String&& value) { m_keyHasBeenSet = true; m_key = std::move(value); }
102 inline void SetKey(const char* value) { m_keyHasBeenSet = true; m_key.assign(value); }
103 inline DeleteObjectRequest& WithKey(const Aws::String& value) { SetKey(value); return *this;}
104 inline DeleteObjectRequest& WithKey(Aws::String&& value) { SetKey(std::move(value)); return *this;}
105 inline DeleteObjectRequest& WithKey(const char* value) { SetKey(value); return *this;}
107
109
116 inline const Aws::String& GetMFA() const{ return m_mFA; }
117 inline bool MFAHasBeenSet() const { return m_mFAHasBeenSet; }
118 inline void SetMFA(const Aws::String& value) { m_mFAHasBeenSet = true; m_mFA = value; }
119 inline void SetMFA(Aws::String&& value) { m_mFAHasBeenSet = true; m_mFA = std::move(value); }
120 inline void SetMFA(const char* value) { m_mFAHasBeenSet = true; m_mFA.assign(value); }
121 inline DeleteObjectRequest& WithMFA(const Aws::String& value) { SetMFA(value); return *this;}
122 inline DeleteObjectRequest& WithMFA(Aws::String&& value) { SetMFA(std::move(value)); return *this;}
123 inline DeleteObjectRequest& WithMFA(const char* value) { SetMFA(value); return *this;}
125
127
132 inline const Aws::String& GetVersionId() const{ return m_versionId; }
133 inline bool VersionIdHasBeenSet() const { return m_versionIdHasBeenSet; }
134 inline void SetVersionId(const Aws::String& value) { m_versionIdHasBeenSet = true; m_versionId = value; }
135 inline void SetVersionId(Aws::String&& value) { m_versionIdHasBeenSet = true; m_versionId = std::move(value); }
136 inline void SetVersionId(const char* value) { m_versionIdHasBeenSet = true; m_versionId.assign(value); }
137 inline DeleteObjectRequest& WithVersionId(const Aws::String& value) { SetVersionId(value); return *this;}
138 inline DeleteObjectRequest& WithVersionId(Aws::String&& value) { SetVersionId(std::move(value)); return *this;}
139 inline DeleteObjectRequest& WithVersionId(const char* value) { SetVersionId(value); return *this;}
141
143
144 inline const RequestPayer& GetRequestPayer() const{ return m_requestPayer; }
145 inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
146 inline void SetRequestPayer(const RequestPayer& value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; }
147 inline void SetRequestPayer(RequestPayer&& value) { m_requestPayerHasBeenSet = true; m_requestPayer = std::move(value); }
148 inline DeleteObjectRequest& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;}
149 inline DeleteObjectRequest& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;}
151
153
159 inline bool GetBypassGovernanceRetention() const{ return m_bypassGovernanceRetention; }
160 inline bool BypassGovernanceRetentionHasBeenSet() const { return m_bypassGovernanceRetentionHasBeenSet; }
161 inline void SetBypassGovernanceRetention(bool value) { m_bypassGovernanceRetentionHasBeenSet = true; m_bypassGovernanceRetention = value; }
164
166
171 inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; }
172 inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
173 inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; }
174 inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); }
175 inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); }
177 inline DeleteObjectRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;}
178 inline DeleteObjectRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;}
180
182
183 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; }
184 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
185 inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; }
186 inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); }
189 inline DeleteObjectRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
190 inline DeleteObjectRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
191 inline DeleteObjectRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
192 inline DeleteObjectRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; }
193 inline DeleteObjectRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
194 inline DeleteObjectRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
195 inline DeleteObjectRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
197 private:
198
199 Aws::String m_bucket;
200 bool m_bucketHasBeenSet = false;
201
202 Aws::String m_key;
203 bool m_keyHasBeenSet = false;
204
205 Aws::String m_mFA;
206 bool m_mFAHasBeenSet = false;
207
208 Aws::String m_versionId;
209 bool m_versionIdHasBeenSet = false;
210
211 RequestPayer m_requestPayer;
212 bool m_requestPayerHasBeenSet = false;
213
214 bool m_bypassGovernanceRetention;
215 bool m_bypassGovernanceRetentionHasBeenSet = false;
216
217 Aws::String m_expectedBucketOwner;
218 bool m_expectedBucketOwnerHasBeenSet = false;
219
220 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
221 bool m_customizedAccessLogTagHasBeenSet = false;
222 };
223
224} // namespace Model
225} // namespace S3
226} // namespace Aws
void SetBucket(const Aws::String &value)
DeleteObjectRequest & AddCustomizedAccessLogTag(const Aws::String &key, const Aws::String &value)
void SetCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
void SetCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
DeleteObjectRequest & AddCustomizedAccessLogTag(Aws::String &&key, Aws::String &&value)
DeleteObjectRequest & WithRequestPayer(RequestPayer &&value)
AWS_S3_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override
DeleteObjectRequest & WithRequestPayer(const RequestPayer &value)
const Aws::String & GetExpectedBucketOwner() const
DeleteObjectRequest & WithExpectedBucketOwner(const Aws::String &value)
void SetKey(const Aws::String &value)
DeleteObjectRequest & WithExpectedBucketOwner(const char *value)
AWS_S3_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
const Aws::String & GetBucket() const
DeleteObjectRequest & WithBucket(const char *value)
DeleteObjectRequest & AddCustomizedAccessLogTag(Aws::String &&key, const Aws::String &value)
DeleteObjectRequest & WithBypassGovernanceRetention(bool value)
DeleteObjectRequest & WithKey(Aws::String &&value)
void SetRequestPayer(const RequestPayer &value)
virtual const char * GetServiceRequestName() const override
const Aws::String & GetVersionId() const
AWS_S3_API void AddQueryStringParameters(Aws::Http::URI &uri) const override
const Aws::String & GetKey() const
const RequestPayer & GetRequestPayer() const
DeleteObjectRequest & AddCustomizedAccessLogTag(const char *key, const char *value)
void SetRequestPayer(RequestPayer &&value)
DeleteObjectRequest & WithMFA(Aws::String &&value)
DeleteObjectRequest & WithKey(const Aws::String &value)
DeleteObjectRequest & WithBucket(const Aws::String &value)
DeleteObjectRequest & AddCustomizedAccessLogTag(const char *key, Aws::String &&value)
DeleteObjectRequest & AddCustomizedAccessLogTag(Aws::String &&key, const char *value)
DeleteObjectRequest & WithCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
DeleteObjectRequest & AddCustomizedAccessLogTag(const Aws::String &key, Aws::String &&value)
DeleteObjectRequest & WithMFA(const Aws::String &value)
void SetVersionId(const Aws::String &value)
DeleteObjectRequest & WithVersionId(const Aws::String &value)
DeleteObjectRequest & WithMFA(const char *value)
DeleteObjectRequest & WithCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
AWS_S3_API Aws::String SerializePayload() const override
DeleteObjectRequest & WithBucket(Aws::String &&value)
AWS_S3_API EndpointParameters GetEndpointContextParams() const override
DeleteObjectRequest & WithVersionId(Aws::String &&value)
DeleteObjectRequest & WithExpectedBucketOwner(Aws::String &&value)
DeleteObjectRequest & WithKey(const char *value)
void SetExpectedBucketOwner(const Aws::String &value)
DeleteObjectRequest & WithVersionId(const char *value)
void SetMFA(const Aws::String &value)
void SetExpectedBucketOwner(Aws::String &&value)
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
void SetExpectedBucketOwner(const char *value)
Aws::Endpoint::EndpointParameters EndpointParameters
Definition S3Request.h:22
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
std::map< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > > Map
std::basic_iostream< char, std::char_traits< char > > IOStream
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String