AWS SDK for C++  1.9.108
AWS SDK for C++
RestoreObjectRequest.h
Go to the documentation of this file.
1 
6 #pragma once
7 #include <aws/s3/S3_EXPORTS.h>
8 #include <aws/s3/S3Request.h>
13 #include <utility>
14 
15 namespace Aws
16 {
17 namespace Http
18 {
19  class URI;
20 } //namespace Http
21 namespace S3
22 {
23 namespace Model
24 {
25 
29  {
30  public:
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 "RestoreObject"; }
38 
39  Aws::String SerializePayload() const override;
40 
41  void AddQueryStringParameters(Aws::Http::URI& uri) const override;
42 
44 
45 
65  inline const Aws::String& GetBucket() const{ return m_bucket; }
66 
86  inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
87 
107  inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; }
108 
128  inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); }
129 
149  inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); }
150 
170  inline RestoreObjectRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;}
171 
191  inline RestoreObjectRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;}
192 
212  inline RestoreObjectRequest& WithBucket(const char* value) { SetBucket(value); return *this;}
213 
214 
218  inline const Aws::String& GetKey() const{ return m_key; }
219 
223  inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
224 
228  inline void SetKey(const Aws::String& value) { m_keyHasBeenSet = true; m_key = value; }
229 
233  inline void SetKey(Aws::String&& value) { m_keyHasBeenSet = true; m_key = std::move(value); }
234 
238  inline void SetKey(const char* value) { m_keyHasBeenSet = true; m_key.assign(value); }
239 
243  inline RestoreObjectRequest& WithKey(const Aws::String& value) { SetKey(value); return *this;}
244 
248  inline RestoreObjectRequest& WithKey(Aws::String&& value) { SetKey(std::move(value)); return *this;}
249 
253  inline RestoreObjectRequest& WithKey(const char* value) { SetKey(value); return *this;}
254 
255 
259  inline const Aws::String& GetVersionId() const{ return m_versionId; }
260 
264  inline bool VersionIdHasBeenSet() const { return m_versionIdHasBeenSet; }
265 
269  inline void SetVersionId(const Aws::String& value) { m_versionIdHasBeenSet = true; m_versionId = value; }
270 
274  inline void SetVersionId(Aws::String&& value) { m_versionIdHasBeenSet = true; m_versionId = std::move(value); }
275 
279  inline void SetVersionId(const char* value) { m_versionIdHasBeenSet = true; m_versionId.assign(value); }
280 
284  inline RestoreObjectRequest& WithVersionId(const Aws::String& value) { SetVersionId(value); return *this;}
285 
289  inline RestoreObjectRequest& WithVersionId(Aws::String&& value) { SetVersionId(std::move(value)); return *this;}
290 
294  inline RestoreObjectRequest& WithVersionId(const char* value) { SetVersionId(value); return *this;}
295 
296 
297 
298  inline const RestoreRequest& GetRestoreRequest() const{ return m_restoreRequest; }
299 
300 
301  inline bool RestoreRequestHasBeenSet() const { return m_restoreRequestHasBeenSet; }
302 
303 
304  inline void SetRestoreRequest(const RestoreRequest& value) { m_restoreRequestHasBeenSet = true; m_restoreRequest = value; }
305 
306 
307  inline void SetRestoreRequest(RestoreRequest&& value) { m_restoreRequestHasBeenSet = true; m_restoreRequest = std::move(value); }
308 
309 
310  inline RestoreObjectRequest& WithRestoreRequest(const RestoreRequest& value) { SetRestoreRequest(value); return *this;}
311 
312 
313  inline RestoreObjectRequest& WithRestoreRequest(RestoreRequest&& value) { SetRestoreRequest(std::move(value)); return *this;}
314 
315 
316 
317  inline const RequestPayer& GetRequestPayer() const{ return m_requestPayer; }
318 
319 
320  inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
321 
322 
323  inline void SetRequestPayer(const RequestPayer& value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; }
324 
325 
326  inline void SetRequestPayer(RequestPayer&& value) { m_requestPayerHasBeenSet = true; m_requestPayer = std::move(value); }
327 
328 
329  inline RestoreObjectRequest& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;}
330 
331 
332  inline RestoreObjectRequest& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;}
333 
334 
340  inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; }
341 
347  inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
348 
354  inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; }
355 
361  inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); }
362 
368  inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); }
369 
375  inline RestoreObjectRequest& WithExpectedBucketOwner(const Aws::String& value) { SetExpectedBucketOwner(value); return *this;}
376 
382  inline RestoreObjectRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;}
383 
389  inline RestoreObjectRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;}
390 
391 
392 
393  inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; }
394 
395 
396  inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
397 
398 
399  inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; }
400 
401 
402  inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); }
403 
404 
405  inline RestoreObjectRequest& WithCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { SetCustomizedAccessLogTag(value); return *this;}
406 
407 
408  inline RestoreObjectRequest& WithCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { SetCustomizedAccessLogTag(std::move(value)); return *this;}
409 
410 
411  inline RestoreObjectRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
412 
413 
414  inline RestoreObjectRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
415 
416 
417  inline RestoreObjectRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
418 
419 
420  inline RestoreObjectRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; }
421 
422 
423  inline RestoreObjectRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
424 
425 
426  inline RestoreObjectRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
427 
428 
429  inline RestoreObjectRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
430 
431  private:
432 
433  Aws::String m_bucket;
434  bool m_bucketHasBeenSet;
435 
436  Aws::String m_key;
437  bool m_keyHasBeenSet;
438 
439  Aws::String m_versionId;
440  bool m_versionIdHasBeenSet;
441 
442  RestoreRequest m_restoreRequest;
443  bool m_restoreRequestHasBeenSet;
444 
445  RequestPayer m_requestPayer;
446  bool m_requestPayerHasBeenSet;
447 
448  Aws::String m_expectedBucketOwner;
449  bool m_expectedBucketOwnerHasBeenSet;
450 
451  Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
452  bool m_customizedAccessLogTagHasBeenSet;
453  };
454 
455 } // namespace Model
456 } // namespace S3
457 } // namespace Aws
Aws::S3::Model::RestoreObjectRequest::AddCustomizedAccessLogTag
RestoreObjectRequest & AddCustomizedAccessLogTag(Aws::String &&key, const Aws::String &value)
Definition: RestoreObjectRequest.h:414
RestoreRequest.h
Aws::S3::Model::RestoreObjectRequest::SetRestoreRequest
void SetRestoreRequest(RestoreRequest &&value)
Definition: RestoreObjectRequest.h:307
Aws::Http::URI
Definition: URI.h:32
Aws::S3::Model::RestoreObjectRequest::SetRestoreRequest
void SetRestoreRequest(const RestoreRequest &value)
Definition: RestoreObjectRequest.h:304
Aws::S3::Model::RestoreObjectRequest::WithVersionId
RestoreObjectRequest & WithVersionId(const Aws::String &value)
Definition: RestoreObjectRequest.h:284
Aws::S3::Model::RestoreObjectRequest::RequestPayerHasBeenSet
bool RequestPayerHasBeenSet() const
Definition: RestoreObjectRequest.h:320
Aws::Http::HeaderValueCollection
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
Definition: HttpTypes.h:53
S3Request.h
Aws::S3::Model::RestoreObjectRequest::WithVersionId
RestoreObjectRequest & WithVersionId(Aws::String &&value)
Definition: RestoreObjectRequest.h:289
Aws::S3::Model::RestoreObjectRequest::WithVersionId
RestoreObjectRequest & WithVersionId(const char *value)
Definition: RestoreObjectRequest.h:294
Aws::S3::Model::RestoreObjectRequest::WithRestoreRequest
RestoreObjectRequest & WithRestoreRequest(const RestoreRequest &value)
Definition: RestoreObjectRequest.h:310
Aws::S3::Model::RestoreObjectRequest::SetBucket
void SetBucket(const char *value)
Definition: RestoreObjectRequest.h:149
Aws::S3::Model::RestoreObjectRequest::BucketHasBeenSet
bool BucketHasBeenSet() const
Definition: RestoreObjectRequest.h:86
Aws::S3::Model::RestoreObjectRequest::CustomizedAccessLogTagHasBeenSet
bool CustomizedAccessLogTagHasBeenSet() const
Definition: RestoreObjectRequest.h:396
Aws::S3::Model::RestoreObjectRequest::SetCustomizedAccessLogTag
void SetCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
Definition: RestoreObjectRequest.h:399
Aws::S3::Model::RestoreObjectRequest::KeyHasBeenSet
bool KeyHasBeenSet() const
Definition: RestoreObjectRequest.h:223
Aws::S3::Model::RestoreRequest
Definition: RestoreRequest.h:36
Aws::S3::Model::RestoreObjectRequest::WithExpectedBucketOwner
RestoreObjectRequest & WithExpectedBucketOwner(Aws::String &&value)
Definition: RestoreObjectRequest.h:382
Aws::S3::Model::RestoreObjectRequest::AddCustomizedAccessLogTag
RestoreObjectRequest & AddCustomizedAccessLogTag(Aws::String &&key, const char *value)
Definition: RestoreObjectRequest.h:426
Aws::S3::Model::RestoreObjectRequest::RestoreRequestHasBeenSet
bool RestoreRequestHasBeenSet() const
Definition: RestoreObjectRequest.h:301
Aws::S3::Model::RestoreObjectRequest::GetExpectedBucketOwner
const Aws::String & GetExpectedBucketOwner() const
Definition: RestoreObjectRequest.h:340
Aws::S3::Model::RestoreObjectRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: RestoreObjectRequest.h:37
Aws::S3::Model::RestoreObjectRequest::SetExpectedBucketOwner
void SetExpectedBucketOwner(Aws::String &&value)
Definition: RestoreObjectRequest.h:361
Aws::S3::Model::RestoreObjectRequest::SetBucket
void SetBucket(Aws::String &&value)
Definition: RestoreObjectRequest.h:128
Aws::S3::Model::RestoreObjectRequest::WithRequestPayer
RestoreObjectRequest & WithRequestPayer(RequestPayer &&value)
Definition: RestoreObjectRequest.h:332
Aws::S3::Model::RestoreObjectRequest::SetCustomizedAccessLogTag
void SetCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
Definition: RestoreObjectRequest.h:402
Aws::S3::Model::RestoreObjectRequest::RestoreObjectRequest
RestoreObjectRequest()
Aws::S3::Model::RestoreObjectRequest::GetBucket
const Aws::String & GetBucket() const
Definition: RestoreObjectRequest.h:65
Aws::S3::Model::RestoreObjectRequest::AddQueryStringParameters
void AddQueryStringParameters(Aws::Http::URI &uri) const override
Aws::S3::Model::RestoreObjectRequest::WithCustomizedAccessLogTag
RestoreObjectRequest & WithCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
Definition: RestoreObjectRequest.h:405
S3_EXPORTS.h
AWS_S3_API
#define AWS_S3_API
Definition: S3_EXPORTS.h:28
Aws::S3::Model::RestoreObjectRequest::WithExpectedBucketOwner
RestoreObjectRequest & WithExpectedBucketOwner(const Aws::String &value)
Definition: RestoreObjectRequest.h:375
Aws::S3::Model::RequestPayer
RequestPayer
Definition: RequestPayer.h:17
Aws::S3::S3Request
Definition: S3Request.h:18
Aws::S3::Model::RestoreObjectRequest::VersionIdHasBeenSet
bool VersionIdHasBeenSet() const
Definition: RestoreObjectRequest.h:264
Aws::S3::Model::RestoreObjectRequest::WithKey
RestoreObjectRequest & WithKey(Aws::String &&value)
Definition: RestoreObjectRequest.h:248
Aws::S3::Model::RestoreObjectRequest::SetExpectedBucketOwner
void SetExpectedBucketOwner(const char *value)
Definition: RestoreObjectRequest.h:368
Aws::S3::Model::RestoreObjectRequest::SetExpectedBucketOwner
void SetExpectedBucketOwner(const Aws::String &value)
Definition: RestoreObjectRequest.h:354
Aws::S3::Model::RestoreObjectRequest::GetRequestSpecificHeaders
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
Aws::S3::Model::RestoreObjectRequest::WithKey
RestoreObjectRequest & WithKey(const Aws::String &value)
Definition: RestoreObjectRequest.h:243
Aws::S3::Model::RestoreObjectRequest::SetVersionId
void SetVersionId(const Aws::String &value)
Definition: RestoreObjectRequest.h:269
Aws::S3::Model::RestoreObjectRequest::SetKey
void SetKey(Aws::String &&value)
Definition: RestoreObjectRequest.h:233
Aws::S3::Model::RestoreObjectRequest::SetVersionId
void SetVersionId(const char *value)
Definition: RestoreObjectRequest.h:279
Aws::S3::Model::RestoreObjectRequest::GetCustomizedAccessLogTag
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
Definition: RestoreObjectRequest.h:393
Aws::S3::Model::RestoreObjectRequest::SetRequestPayer
void SetRequestPayer(const RequestPayer &value)
Definition: RestoreObjectRequest.h:323
Aws::S3::Model::RestoreObjectRequest::WithBucket
RestoreObjectRequest & WithBucket(const char *value)
Definition: RestoreObjectRequest.h:212
Aws::S3::Model::RestoreObjectRequest::GetKey
const Aws::String & GetKey() const
Definition: RestoreObjectRequest.h:218
AWSString.h
Aws::S3::Model::RestoreObjectRequest::WithKey
RestoreObjectRequest & WithKey(const char *value)
Definition: RestoreObjectRequest.h:253
Aws::S3::Model::RestoreObjectRequest::SetVersionId
void SetVersionId(Aws::String &&value)
Definition: RestoreObjectRequest.h:274
Aws::S3::Model::RestoreObjectRequest::AddCustomizedAccessLogTag
RestoreObjectRequest & AddCustomizedAccessLogTag(Aws::String &&key, Aws::String &&value)
Definition: RestoreObjectRequest.h:420
Aws::S3::Model::RestoreObjectRequest::WithBucket
RestoreObjectRequest & WithBucket(Aws::String &&value)
Definition: RestoreObjectRequest.h:191
RequestPayer.h
Aws::S3::Model::RestoreObjectRequest::AddCustomizedAccessLogTag
RestoreObjectRequest & AddCustomizedAccessLogTag(const char *key, const char *value)
Definition: RestoreObjectRequest.h:429
Aws::S3::Model::RestoreObjectRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::S3::Model::RestoreObjectRequest::GetVersionId
const Aws::String & GetVersionId() const
Definition: RestoreObjectRequest.h:259
Aws::S3::Model::RestoreObjectRequest::WithBucket
RestoreObjectRequest & WithBucket(const Aws::String &value)
Definition: RestoreObjectRequest.h:170
Aws::S3::Model::RestoreObjectRequest
Definition: RestoreObjectRequest.h:29
Aws
Definition: AccessManagementClient.h:15
Aws::S3::Model::RestoreObjectRequest::GetRequestPayer
const RequestPayer & GetRequestPayer() const
Definition: RestoreObjectRequest.h:317
Aws::S3::Model::RestoreObjectRequest::AddCustomizedAccessLogTag
RestoreObjectRequest & AddCustomizedAccessLogTag(const Aws::String &key, const Aws::String &value)
Definition: RestoreObjectRequest.h:411
Aws::S3::Model::RestoreObjectRequest::SetKey
void SetKey(const char *value)
Definition: RestoreObjectRequest.h:238
Aws::S3::Model::RestoreObjectRequest::AddCustomizedAccessLogTag
RestoreObjectRequest & AddCustomizedAccessLogTag(const Aws::String &key, Aws::String &&value)
Definition: RestoreObjectRequest.h:417
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::S3::Model::RestoreObjectRequest::WithRestoreRequest
RestoreObjectRequest & WithRestoreRequest(RestoreRequest &&value)
Definition: RestoreObjectRequest.h:313
Aws::S3::Model::RestoreObjectRequest::WithCustomizedAccessLogTag
RestoreObjectRequest & WithCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
Definition: RestoreObjectRequest.h:408
Aws::S3::Model::RestoreObjectRequest::SetKey
void SetKey(const Aws::String &value)
Definition: RestoreObjectRequest.h:228
Aws::S3::Model::RestoreObjectRequest::SetBucket
void SetBucket(const Aws::String &value)
Definition: RestoreObjectRequest.h:107
Aws::S3::Model::RestoreObjectRequest::WithExpectedBucketOwner
RestoreObjectRequest & WithExpectedBucketOwner(const char *value)
Definition: RestoreObjectRequest.h:389
Aws::S3::Model::RestoreObjectRequest::GetRestoreRequest
const RestoreRequest & GetRestoreRequest() const
Definition: RestoreObjectRequest.h:298
Aws::S3::Model::RestoreObjectRequest::ExpectedBucketOwnerHasBeenSet
bool ExpectedBucketOwnerHasBeenSet() const
Definition: RestoreObjectRequest.h:347
Aws::S3::Model::RestoreObjectRequest::AddCustomizedAccessLogTag
RestoreObjectRequest & AddCustomizedAccessLogTag(const char *key, Aws::String &&value)
Definition: RestoreObjectRequest.h:423
AWSMap.h
Aws::S3::ARNService::S3
static const char S3[]
Definition: S3ARN.h:25
Aws::Map
std::map< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > > Map
Definition: AWSMap.h:19
Aws::S3::Model::RestoreObjectRequest::SetRequestPayer
void SetRequestPayer(RequestPayer &&value)
Definition: RestoreObjectRequest.h:326
Aws::S3::Model::RestoreObjectRequest::WithRequestPayer
RestoreObjectRequest & WithRequestPayer(const RequestPayer &value)
Definition: RestoreObjectRequest.h:329