AWS SDK for C++

AWS SDK for C++ Version 1.11.695

Loading...
Searching...
No Matches
RenameObjectRequest.h
1
6#pragma once
7#include <aws/core/utils/DateTime.h>
8#include <aws/core/utils/UUID.h>
9#include <aws/core/utils/memory/stl/AWSMap.h>
10#include <aws/core/utils/memory/stl/AWSString.h>
11#include <aws/s3/S3Request.h>
12#include <aws/s3/S3_EXPORTS.h>
13
14#include <utility>
15
16namespace Aws {
17namespace Http {
18class URI;
19} // namespace Http
20namespace S3 {
21namespace Model {
22
26 public:
27 AWS_S3_API RenameObjectRequest() = default;
28
29 // Service request name is the Operation name which will send this request out,
30 // each operation should has unique request name, so that we can get operation's name from this request.
31 // Note: this is not true for response, multiple operations may have the same response name,
32 // so we can not get operation's name from response.
33 inline virtual const char* GetServiceRequestName() const override { return "RenameObject"; }
34
35 AWS_S3_API Aws::String SerializePayload() const override;
36
37 AWS_S3_API void AddQueryStringParameters(Aws::Http::URI& uri) const override;
38
40
44 AWS_S3_API EndpointParameters GetEndpointContextParams() const override;
45
47
59 inline const Aws::String& GetBucket() const { return m_bucket; }
60 inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
61 template <typename BucketT = Aws::String>
62 void SetBucket(BucketT&& value) {
63 m_bucketHasBeenSet = true;
64 m_bucket = std::forward<BucketT>(value);
65 }
66 template <typename BucketT = Aws::String>
67 RenameObjectRequest& WithBucket(BucketT&& value) {
68 SetBucket(std::forward<BucketT>(value));
69 return *this;
70 }
72
74
77 inline const Aws::String& GetKey() const { return m_key; }
78 inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
79 template <typename KeyT = Aws::String>
80 void SetKey(KeyT&& value) {
81 m_keyHasBeenSet = true;
82 m_key = std::forward<KeyT>(value);
83 }
84 template <typename KeyT = Aws::String>
86 SetKey(std::forward<KeyT>(value));
87 return *this;
88 }
90
92
96 inline const Aws::String& GetRenameSource() const { return m_renameSource; }
97 inline bool RenameSourceHasBeenSet() const { return m_renameSourceHasBeenSet; }
98 template <typename RenameSourceT = Aws::String>
99 void SetRenameSource(RenameSourceT&& value) {
100 m_renameSourceHasBeenSet = true;
101 m_renameSource = std::forward<RenameSourceT>(value);
102 }
103 template <typename RenameSourceT = Aws::String>
104 RenameObjectRequest& WithRenameSource(RenameSourceT&& value) {
105 SetRenameSource(std::forward<RenameSourceT>(value));
106 return *this;
107 }
109
111
118 inline const Aws::String& GetDestinationIfMatch() const { return m_destinationIfMatch; }
119 inline bool DestinationIfMatchHasBeenSet() const { return m_destinationIfMatchHasBeenSet; }
120 template <typename DestinationIfMatchT = Aws::String>
121 void SetDestinationIfMatch(DestinationIfMatchT&& value) {
122 m_destinationIfMatchHasBeenSet = true;
123 m_destinationIfMatch = std::forward<DestinationIfMatchT>(value);
124 }
125 template <typename DestinationIfMatchT = Aws::String>
126 RenameObjectRequest& WithDestinationIfMatch(DestinationIfMatchT&& value) {
127 SetDestinationIfMatch(std::forward<DestinationIfMatchT>(value));
128 return *this;
129 }
131
133
142 inline const Aws::String& GetDestinationIfNoneMatch() const { return m_destinationIfNoneMatch; }
143 inline bool DestinationIfNoneMatchHasBeenSet() const { return m_destinationIfNoneMatchHasBeenSet; }
144 template <typename DestinationIfNoneMatchT = Aws::String>
145 void SetDestinationIfNoneMatch(DestinationIfNoneMatchT&& value) {
146 m_destinationIfNoneMatchHasBeenSet = true;
147 m_destinationIfNoneMatch = std::forward<DestinationIfNoneMatchT>(value);
148 }
149 template <typename DestinationIfNoneMatchT = Aws::String>
150 RenameObjectRequest& WithDestinationIfNoneMatch(DestinationIfNoneMatchT&& value) {
151 SetDestinationIfNoneMatch(std::forward<DestinationIfNoneMatchT>(value));
152 return *this;
153 }
155
157
161 inline const Aws::Utils::DateTime& GetDestinationIfModifiedSince() const { return m_destinationIfModifiedSince; }
162 inline bool DestinationIfModifiedSinceHasBeenSet() const { return m_destinationIfModifiedSinceHasBeenSet; }
163 template <typename DestinationIfModifiedSinceT = Aws::Utils::DateTime>
164 void SetDestinationIfModifiedSince(DestinationIfModifiedSinceT&& value) {
165 m_destinationIfModifiedSinceHasBeenSet = true;
166 m_destinationIfModifiedSince = std::forward<DestinationIfModifiedSinceT>(value);
167 }
168 template <typename DestinationIfModifiedSinceT = Aws::Utils::DateTime>
169 RenameObjectRequest& WithDestinationIfModifiedSince(DestinationIfModifiedSinceT&& value) {
170 SetDestinationIfModifiedSince(std::forward<DestinationIfModifiedSinceT>(value));
171 return *this;
172 }
174
176
179 inline const Aws::Utils::DateTime& GetDestinationIfUnmodifiedSince() const { return m_destinationIfUnmodifiedSince; }
180 inline bool DestinationIfUnmodifiedSinceHasBeenSet() const { return m_destinationIfUnmodifiedSinceHasBeenSet; }
181 template <typename DestinationIfUnmodifiedSinceT = Aws::Utils::DateTime>
182 void SetDestinationIfUnmodifiedSince(DestinationIfUnmodifiedSinceT&& value) {
183 m_destinationIfUnmodifiedSinceHasBeenSet = true;
184 m_destinationIfUnmodifiedSince = std::forward<DestinationIfUnmodifiedSinceT>(value);
185 }
186 template <typename DestinationIfUnmodifiedSinceT = Aws::Utils::DateTime>
187 RenameObjectRequest& WithDestinationIfUnmodifiedSince(DestinationIfUnmodifiedSinceT&& value) {
188 SetDestinationIfUnmodifiedSince(std::forward<DestinationIfUnmodifiedSinceT>(value));
189 return *this;
190 }
192
194
198 inline const Aws::String& GetSourceIfMatch() const { return m_sourceIfMatch; }
199 inline bool SourceIfMatchHasBeenSet() const { return m_sourceIfMatchHasBeenSet; }
200 template <typename SourceIfMatchT = Aws::String>
201 void SetSourceIfMatch(SourceIfMatchT&& value) {
202 m_sourceIfMatchHasBeenSet = true;
203 m_sourceIfMatch = std::forward<SourceIfMatchT>(value);
204 }
205 template <typename SourceIfMatchT = Aws::String>
206 RenameObjectRequest& WithSourceIfMatch(SourceIfMatchT&& value) {
207 SetSourceIfMatch(std::forward<SourceIfMatchT>(value));
208 return *this;
209 }
211
213
219 inline const Aws::String& GetSourceIfNoneMatch() const { return m_sourceIfNoneMatch; }
220 inline bool SourceIfNoneMatchHasBeenSet() const { return m_sourceIfNoneMatchHasBeenSet; }
221 template <typename SourceIfNoneMatchT = Aws::String>
222 void SetSourceIfNoneMatch(SourceIfNoneMatchT&& value) {
223 m_sourceIfNoneMatchHasBeenSet = true;
224 m_sourceIfNoneMatch = std::forward<SourceIfNoneMatchT>(value);
225 }
226 template <typename SourceIfNoneMatchT = Aws::String>
227 RenameObjectRequest& WithSourceIfNoneMatch(SourceIfNoneMatchT&& value) {
228 SetSourceIfNoneMatch(std::forward<SourceIfNoneMatchT>(value));
229 return *this;
230 }
232
234
238 inline const Aws::Utils::DateTime& GetSourceIfModifiedSince() const { return m_sourceIfModifiedSince; }
239 inline bool SourceIfModifiedSinceHasBeenSet() const { return m_sourceIfModifiedSinceHasBeenSet; }
240 template <typename SourceIfModifiedSinceT = Aws::Utils::DateTime>
241 void SetSourceIfModifiedSince(SourceIfModifiedSinceT&& value) {
242 m_sourceIfModifiedSinceHasBeenSet = true;
243 m_sourceIfModifiedSince = std::forward<SourceIfModifiedSinceT>(value);
244 }
245 template <typename SourceIfModifiedSinceT = Aws::Utils::DateTime>
246 RenameObjectRequest& WithSourceIfModifiedSince(SourceIfModifiedSinceT&& value) {
247 SetSourceIfModifiedSince(std::forward<SourceIfModifiedSinceT>(value));
248 return *this;
249 }
251
253
257 inline const Aws::Utils::DateTime& GetSourceIfUnmodifiedSince() const { return m_sourceIfUnmodifiedSince; }
258 inline bool SourceIfUnmodifiedSinceHasBeenSet() const { return m_sourceIfUnmodifiedSinceHasBeenSet; }
259 template <typename SourceIfUnmodifiedSinceT = Aws::Utils::DateTime>
260 void SetSourceIfUnmodifiedSince(SourceIfUnmodifiedSinceT&& value) {
261 m_sourceIfUnmodifiedSinceHasBeenSet = true;
262 m_sourceIfUnmodifiedSince = std::forward<SourceIfUnmodifiedSinceT>(value);
263 }
264 template <typename SourceIfUnmodifiedSinceT = Aws::Utils::DateTime>
265 RenameObjectRequest& WithSourceIfUnmodifiedSince(SourceIfUnmodifiedSinceT&& value) {
266 SetSourceIfUnmodifiedSince(std::forward<SourceIfUnmodifiedSinceT>(value));
267 return *this;
268 }
270
272
283 inline const Aws::String& GetClientToken() const { return m_clientToken; }
284 inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; }
285 template <typename ClientTokenT = Aws::String>
286 void SetClientToken(ClientTokenT&& value) {
287 m_clientTokenHasBeenSet = true;
288 m_clientToken = std::forward<ClientTokenT>(value);
289 }
290 template <typename ClientTokenT = Aws::String>
291 RenameObjectRequest& WithClientToken(ClientTokenT&& value) {
292 SetClientToken(std::forward<ClientTokenT>(value));
293 return *this;
294 }
296
298
299 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const { return m_customizedAccessLogTag; }
300 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
301 template <typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
302 void SetCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) {
303 m_customizedAccessLogTagHasBeenSet = true;
304 m_customizedAccessLogTag = std::forward<CustomizedAccessLogTagT>(value);
305 }
306 template <typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
307 RenameObjectRequest& WithCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) {
308 SetCustomizedAccessLogTag(std::forward<CustomizedAccessLogTagT>(value));
309 return *this;
310 }
311 template <typename CustomizedAccessLogTagKeyT = Aws::String, typename CustomizedAccessLogTagValueT = Aws::String>
312 RenameObjectRequest& AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT&& key, CustomizedAccessLogTagValueT&& value) {
313 m_customizedAccessLogTagHasBeenSet = true;
314 m_customizedAccessLogTag.emplace(std::forward<CustomizedAccessLogTagKeyT>(key), std::forward<CustomizedAccessLogTagValueT>(value));
315 return *this;
316 }
318 private:
319 Aws::String m_bucket;
320 bool m_bucketHasBeenSet = false;
321
322 Aws::String m_key;
323 bool m_keyHasBeenSet = false;
324
325 Aws::String m_renameSource;
326 bool m_renameSourceHasBeenSet = false;
327
328 Aws::String m_destinationIfMatch;
329 bool m_destinationIfMatchHasBeenSet = false;
330
331 Aws::String m_destinationIfNoneMatch;
332 bool m_destinationIfNoneMatchHasBeenSet = false;
333
334 Aws::Utils::DateTime m_destinationIfModifiedSince{};
335 bool m_destinationIfModifiedSinceHasBeenSet = false;
336
337 Aws::Utils::DateTime m_destinationIfUnmodifiedSince{};
338 bool m_destinationIfUnmodifiedSinceHasBeenSet = false;
339
340 Aws::String m_sourceIfMatch;
341 bool m_sourceIfMatchHasBeenSet = false;
342
343 Aws::String m_sourceIfNoneMatch;
344 bool m_sourceIfNoneMatchHasBeenSet = false;
345
346 Aws::Utils::DateTime m_sourceIfModifiedSince{};
347 bool m_sourceIfModifiedSinceHasBeenSet = false;
348
349 Aws::Utils::DateTime m_sourceIfUnmodifiedSince{};
350 bool m_sourceIfUnmodifiedSinceHasBeenSet = false;
351
353 bool m_clientTokenHasBeenSet = true;
354
355 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
356 bool m_customizedAccessLogTagHasBeenSet = false;
357};
358
359} // namespace Model
360} // namespace S3
361} // namespace Aws
AWS_S3_API Aws::String SerializePayload() const override
virtual const char * GetServiceRequestName() const override
RenameObjectRequest & WithRenameSource(RenameSourceT &&value)
RenameObjectRequest & WithClientToken(ClientTokenT &&value)
AWS_S3_API RenameObjectRequest()=default
const Aws::String & GetSourceIfMatch() const
RenameObjectRequest & WithBucket(BucketT &&value)
void SetDestinationIfUnmodifiedSince(DestinationIfUnmodifiedSinceT &&value)
const Aws::String & GetClientToken() const
RenameObjectRequest & WithDestinationIfMatch(DestinationIfMatchT &&value)
RenameObjectRequest & WithDestinationIfModifiedSince(DestinationIfModifiedSinceT &&value)
RenameObjectRequest & WithCustomizedAccessLogTag(CustomizedAccessLogTagT &&value)
const Aws::Utils::DateTime & GetDestinationIfUnmodifiedSince() const
RenameObjectRequest & WithSourceIfNoneMatch(SourceIfNoneMatchT &&value)
RenameObjectRequest & WithKey(KeyT &&value)
const Aws::String & GetKey() const
void SetRenameSource(RenameSourceT &&value)
const Aws::Utils::DateTime & GetDestinationIfModifiedSince() const
RenameObjectRequest & WithSourceIfMatch(SourceIfMatchT &&value)
void SetDestinationIfNoneMatch(DestinationIfNoneMatchT &&value)
const Aws::Utils::DateTime & GetSourceIfUnmodifiedSince() const
RenameObjectRequest & AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT &&key, CustomizedAccessLogTagValueT &&value)
AWS_S3_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
void SetClientToken(ClientTokenT &&value)
const Aws::Utils::DateTime & GetSourceIfModifiedSince() const
RenameObjectRequest & WithSourceIfModifiedSince(SourceIfModifiedSinceT &&value)
void SetSourceIfMatch(SourceIfMatchT &&value)
AWS_S3_API void AddQueryStringParameters(Aws::Http::URI &uri) const override
RenameObjectRequest & WithDestinationIfNoneMatch(DestinationIfNoneMatchT &&value)
const Aws::String & GetSourceIfNoneMatch() const
void SetDestinationIfModifiedSince(DestinationIfModifiedSinceT &&value)
RenameObjectRequest & WithSourceIfUnmodifiedSince(SourceIfUnmodifiedSinceT &&value)
void SetDestinationIfMatch(DestinationIfMatchT &&value)
void SetCustomizedAccessLogTag(CustomizedAccessLogTagT &&value)
AWS_S3_API EndpointParameters GetEndpointContextParams() const override
const Aws::String & GetDestinationIfNoneMatch() const
const Aws::String & GetDestinationIfMatch() const
void SetSourceIfNoneMatch(SourceIfNoneMatchT &&value)
void SetSourceIfUnmodifiedSince(SourceIfUnmodifiedSinceT &&value)
const Aws::String & GetBucket() const
RenameObjectRequest & WithDestinationIfUnmodifiedSince(DestinationIfUnmodifiedSinceT &&value)
void SetSourceIfModifiedSince(SourceIfModifiedSinceT &&value)
const Aws::String & GetRenameSource() const
Aws::Endpoint::EndpointParameters EndpointParameters
Definition S3Request.h:19
static Aws::Utils::UUID PseudoRandomUUID()
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