AWS SDK for C++

AWS SDK for C++ Version 1.11.606

Loading...
Searching...
No Matches
RenameObjectRequest.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/core/utils/DateTime.h>
11#include <aws/core/utils/memory/stl/AWSMap.h>
12#include <utility>
13#include <aws/core/utils/UUID.h>
14
15namespace Aws
16{
17namespace Http
18{
19 class URI;
20} //namespace Http
21namespace S3
22{
23namespace Model
24{
25
29 {
30 public:
31 AWS_S3_API RenameObjectRequest() = default;
32
33 // Service request name is the Operation name which will send this request out,
34 // each operation should has unique request name, so that we can get operation's name from this request.
35 // Note: this is not true for response, multiple operations may have the same response name,
36 // so we can not get operation's name from response.
37 inline virtual const char* GetServiceRequestName() const override { return "RenameObject"; }
38
39 AWS_S3_API Aws::String SerializePayload() const override;
40
41 AWS_S3_API void AddQueryStringParameters(Aws::Http::URI& uri) const override;
42
44
48 AWS_S3_API EndpointParameters GetEndpointContextParams() const override;
49
51
63 inline const Aws::String& GetBucket() const { return m_bucket; }
64 inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
65 template<typename BucketT = Aws::String>
66 void SetBucket(BucketT&& value) { m_bucketHasBeenSet = true; m_bucket = std::forward<BucketT>(value); }
67 template<typename BucketT = Aws::String>
68 RenameObjectRequest& WithBucket(BucketT&& value) { SetBucket(std::forward<BucketT>(value)); return *this;}
70
72
75 inline const Aws::String& GetKey() const { return m_key; }
76 inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
77 template<typename KeyT = Aws::String>
78 void SetKey(KeyT&& value) { m_keyHasBeenSet = true; m_key = std::forward<KeyT>(value); }
79 template<typename KeyT = Aws::String>
80 RenameObjectRequest& WithKey(KeyT&& value) { SetKey(std::forward<KeyT>(value)); return *this;}
82
84
88 inline const Aws::String& GetRenameSource() const { return m_renameSource; }
89 inline bool RenameSourceHasBeenSet() const { return m_renameSourceHasBeenSet; }
90 template<typename RenameSourceT = Aws::String>
91 void SetRenameSource(RenameSourceT&& value) { m_renameSourceHasBeenSet = true; m_renameSource = std::forward<RenameSourceT>(value); }
92 template<typename RenameSourceT = Aws::String>
93 RenameObjectRequest& WithRenameSource(RenameSourceT&& value) { SetRenameSource(std::forward<RenameSourceT>(value)); return *this;}
95
97
104 inline const Aws::String& GetDestinationIfMatch() const { return m_destinationIfMatch; }
105 inline bool DestinationIfMatchHasBeenSet() const { return m_destinationIfMatchHasBeenSet; }
106 template<typename DestinationIfMatchT = Aws::String>
107 void SetDestinationIfMatch(DestinationIfMatchT&& value) { m_destinationIfMatchHasBeenSet = true; m_destinationIfMatch = std::forward<DestinationIfMatchT>(value); }
108 template<typename DestinationIfMatchT = Aws::String>
109 RenameObjectRequest& WithDestinationIfMatch(DestinationIfMatchT&& value) { SetDestinationIfMatch(std::forward<DestinationIfMatchT>(value)); return *this;}
111
113
122 inline const Aws::String& GetDestinationIfNoneMatch() const { return m_destinationIfNoneMatch; }
123 inline bool DestinationIfNoneMatchHasBeenSet() const { return m_destinationIfNoneMatchHasBeenSet; }
124 template<typename DestinationIfNoneMatchT = Aws::String>
125 void SetDestinationIfNoneMatch(DestinationIfNoneMatchT&& value) { m_destinationIfNoneMatchHasBeenSet = true; m_destinationIfNoneMatch = std::forward<DestinationIfNoneMatchT>(value); }
126 template<typename DestinationIfNoneMatchT = Aws::String>
127 RenameObjectRequest& WithDestinationIfNoneMatch(DestinationIfNoneMatchT&& value) { SetDestinationIfNoneMatch(std::forward<DestinationIfNoneMatchT>(value)); return *this;}
129
131
135 inline const Aws::Utils::DateTime& GetDestinationIfModifiedSince() const { return m_destinationIfModifiedSince; }
136 inline bool DestinationIfModifiedSinceHasBeenSet() const { return m_destinationIfModifiedSinceHasBeenSet; }
137 template<typename DestinationIfModifiedSinceT = Aws::Utils::DateTime>
138 void SetDestinationIfModifiedSince(DestinationIfModifiedSinceT&& value) { m_destinationIfModifiedSinceHasBeenSet = true; m_destinationIfModifiedSince = std::forward<DestinationIfModifiedSinceT>(value); }
139 template<typename DestinationIfModifiedSinceT = Aws::Utils::DateTime>
140 RenameObjectRequest& WithDestinationIfModifiedSince(DestinationIfModifiedSinceT&& value) { SetDestinationIfModifiedSince(std::forward<DestinationIfModifiedSinceT>(value)); return *this;}
142
144
147 inline const Aws::Utils::DateTime& GetDestinationIfUnmodifiedSince() const { return m_destinationIfUnmodifiedSince; }
148 inline bool DestinationIfUnmodifiedSinceHasBeenSet() const { return m_destinationIfUnmodifiedSinceHasBeenSet; }
149 template<typename DestinationIfUnmodifiedSinceT = Aws::Utils::DateTime>
150 void SetDestinationIfUnmodifiedSince(DestinationIfUnmodifiedSinceT&& value) { m_destinationIfUnmodifiedSinceHasBeenSet = true; m_destinationIfUnmodifiedSince = std::forward<DestinationIfUnmodifiedSinceT>(value); }
151 template<typename DestinationIfUnmodifiedSinceT = Aws::Utils::DateTime>
152 RenameObjectRequest& WithDestinationIfUnmodifiedSince(DestinationIfUnmodifiedSinceT&& value) { SetDestinationIfUnmodifiedSince(std::forward<DestinationIfUnmodifiedSinceT>(value)); return *this;}
154
156
160 inline const Aws::String& GetSourceIfMatch() const { return m_sourceIfMatch; }
161 inline bool SourceIfMatchHasBeenSet() const { return m_sourceIfMatchHasBeenSet; }
162 template<typename SourceIfMatchT = Aws::String>
163 void SetSourceIfMatch(SourceIfMatchT&& value) { m_sourceIfMatchHasBeenSet = true; m_sourceIfMatch = std::forward<SourceIfMatchT>(value); }
164 template<typename SourceIfMatchT = Aws::String>
165 RenameObjectRequest& WithSourceIfMatch(SourceIfMatchT&& value) { SetSourceIfMatch(std::forward<SourceIfMatchT>(value)); return *this;}
167
169
175 inline const Aws::String& GetSourceIfNoneMatch() const { return m_sourceIfNoneMatch; }
176 inline bool SourceIfNoneMatchHasBeenSet() const { return m_sourceIfNoneMatchHasBeenSet; }
177 template<typename SourceIfNoneMatchT = Aws::String>
178 void SetSourceIfNoneMatch(SourceIfNoneMatchT&& value) { m_sourceIfNoneMatchHasBeenSet = true; m_sourceIfNoneMatch = std::forward<SourceIfNoneMatchT>(value); }
179 template<typename SourceIfNoneMatchT = Aws::String>
180 RenameObjectRequest& WithSourceIfNoneMatch(SourceIfNoneMatchT&& value) { SetSourceIfNoneMatch(std::forward<SourceIfNoneMatchT>(value)); return *this;}
182
184
188 inline const Aws::Utils::DateTime& GetSourceIfModifiedSince() const { return m_sourceIfModifiedSince; }
189 inline bool SourceIfModifiedSinceHasBeenSet() const { return m_sourceIfModifiedSinceHasBeenSet; }
190 template<typename SourceIfModifiedSinceT = Aws::Utils::DateTime>
191 void SetSourceIfModifiedSince(SourceIfModifiedSinceT&& value) { m_sourceIfModifiedSinceHasBeenSet = true; m_sourceIfModifiedSince = std::forward<SourceIfModifiedSinceT>(value); }
192 template<typename SourceIfModifiedSinceT = Aws::Utils::DateTime>
193 RenameObjectRequest& WithSourceIfModifiedSince(SourceIfModifiedSinceT&& value) { SetSourceIfModifiedSince(std::forward<SourceIfModifiedSinceT>(value)); return *this;}
195
197
201 inline const Aws::Utils::DateTime& GetSourceIfUnmodifiedSince() const { return m_sourceIfUnmodifiedSince; }
202 inline bool SourceIfUnmodifiedSinceHasBeenSet() const { return m_sourceIfUnmodifiedSinceHasBeenSet; }
203 template<typename SourceIfUnmodifiedSinceT = Aws::Utils::DateTime>
204 void SetSourceIfUnmodifiedSince(SourceIfUnmodifiedSinceT&& value) { m_sourceIfUnmodifiedSinceHasBeenSet = true; m_sourceIfUnmodifiedSince = std::forward<SourceIfUnmodifiedSinceT>(value); }
205 template<typename SourceIfUnmodifiedSinceT = Aws::Utils::DateTime>
206 RenameObjectRequest& WithSourceIfUnmodifiedSince(SourceIfUnmodifiedSinceT&& value) { SetSourceIfUnmodifiedSince(std::forward<SourceIfUnmodifiedSinceT>(value)); return *this;}
208
210
221 inline const Aws::String& GetClientToken() const { return m_clientToken; }
222 inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; }
223 template<typename ClientTokenT = Aws::String>
224 void SetClientToken(ClientTokenT&& value) { m_clientTokenHasBeenSet = true; m_clientToken = std::forward<ClientTokenT>(value); }
225 template<typename ClientTokenT = Aws::String>
226 RenameObjectRequest& WithClientToken(ClientTokenT&& value) { SetClientToken(std::forward<ClientTokenT>(value)); return *this;}
228
230
231 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const { return m_customizedAccessLogTag; }
232 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
233 template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
234 void SetCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::forward<CustomizedAccessLogTagT>(value); }
235 template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
236 RenameObjectRequest& WithCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) { SetCustomizedAccessLogTag(std::forward<CustomizedAccessLogTagT>(value)); return *this;}
237 template<typename CustomizedAccessLogTagKeyT = Aws::String, typename CustomizedAccessLogTagValueT = Aws::String>
238 RenameObjectRequest& AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT&& key, CustomizedAccessLogTagValueT&& value) {
239 m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::forward<CustomizedAccessLogTagKeyT>(key), std::forward<CustomizedAccessLogTagValueT>(value)); return *this;
240 }
242 private:
243
244 Aws::String m_bucket;
245 bool m_bucketHasBeenSet = false;
246
247 Aws::String m_key;
248 bool m_keyHasBeenSet = false;
249
250 Aws::String m_renameSource;
251 bool m_renameSourceHasBeenSet = false;
252
253 Aws::String m_destinationIfMatch;
254 bool m_destinationIfMatchHasBeenSet = false;
255
256 Aws::String m_destinationIfNoneMatch;
257 bool m_destinationIfNoneMatchHasBeenSet = false;
258
259 Aws::Utils::DateTime m_destinationIfModifiedSince{};
260 bool m_destinationIfModifiedSinceHasBeenSet = false;
261
262 Aws::Utils::DateTime m_destinationIfUnmodifiedSince{};
263 bool m_destinationIfUnmodifiedSinceHasBeenSet = false;
264
265 Aws::String m_sourceIfMatch;
266 bool m_sourceIfMatchHasBeenSet = false;
267
268 Aws::String m_sourceIfNoneMatch;
269 bool m_sourceIfNoneMatchHasBeenSet = false;
270
271 Aws::Utils::DateTime m_sourceIfModifiedSince{};
272 bool m_sourceIfModifiedSinceHasBeenSet = false;
273
274 Aws::Utils::DateTime m_sourceIfUnmodifiedSince{};
275 bool m_sourceIfUnmodifiedSinceHasBeenSet = false;
276
278 bool m_clientTokenHasBeenSet = true;
279
280 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
281 bool m_customizedAccessLogTagHasBeenSet = false;
282 };
283
284} // namespace Model
285} // namespace S3
286} // 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:22
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