AWS SDK for C++

AWS SDK for C++ Version 1.11.606

Loading...
Searching...
No Matches
GetObjectRetentionRequest.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 GetObjectRetentionRequest() = default;
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 "GetObjectRetention"; }
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
67 inline const Aws::String& GetBucket() const { return m_bucket; }
68 inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
69 template<typename BucketT = Aws::String>
70 void SetBucket(BucketT&& value) { m_bucketHasBeenSet = true; m_bucket = std::forward<BucketT>(value); }
71 template<typename BucketT = Aws::String>
72 GetObjectRetentionRequest& WithBucket(BucketT&& value) { SetBucket(std::forward<BucketT>(value)); return *this;}
74
76
80 inline const Aws::String& GetKey() const { return m_key; }
81 inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
82 template<typename KeyT = Aws::String>
83 void SetKey(KeyT&& value) { m_keyHasBeenSet = true; m_key = std::forward<KeyT>(value); }
84 template<typename KeyT = Aws::String>
85 GetObjectRetentionRequest& WithKey(KeyT&& value) { SetKey(std::forward<KeyT>(value)); return *this;}
87
89
93 inline const Aws::String& GetVersionId() const { return m_versionId; }
94 inline bool VersionIdHasBeenSet() const { return m_versionIdHasBeenSet; }
95 template<typename VersionIdT = Aws::String>
96 void SetVersionId(VersionIdT&& value) { m_versionIdHasBeenSet = true; m_versionId = std::forward<VersionIdT>(value); }
97 template<typename VersionIdT = Aws::String>
98 GetObjectRetentionRequest& WithVersionId(VersionIdT&& value) { SetVersionId(std::forward<VersionIdT>(value)); return *this;}
100
102
103 inline RequestPayer GetRequestPayer() const { return m_requestPayer; }
104 inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
105 inline void SetRequestPayer(RequestPayer value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; }
108
110
115 inline const Aws::String& GetExpectedBucketOwner() const { return m_expectedBucketOwner; }
116 inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
117 template<typename ExpectedBucketOwnerT = Aws::String>
118 void SetExpectedBucketOwner(ExpectedBucketOwnerT&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::forward<ExpectedBucketOwnerT>(value); }
119 template<typename ExpectedBucketOwnerT = Aws::String>
120 GetObjectRetentionRequest& WithExpectedBucketOwner(ExpectedBucketOwnerT&& value) { SetExpectedBucketOwner(std::forward<ExpectedBucketOwnerT>(value)); return *this;}
122
124
125 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const { return m_customizedAccessLogTag; }
126 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
127 template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
128 void SetCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::forward<CustomizedAccessLogTagT>(value); }
129 template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
130 GetObjectRetentionRequest& WithCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) { SetCustomizedAccessLogTag(std::forward<CustomizedAccessLogTagT>(value)); return *this;}
131 template<typename CustomizedAccessLogTagKeyT = Aws::String, typename CustomizedAccessLogTagValueT = Aws::String>
132 GetObjectRetentionRequest& AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT&& key, CustomizedAccessLogTagValueT&& value) {
133 m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::forward<CustomizedAccessLogTagKeyT>(key), std::forward<CustomizedAccessLogTagValueT>(value)); return *this;
134 }
136 private:
137
138 Aws::String m_bucket;
139 bool m_bucketHasBeenSet = false;
140
141 Aws::String m_key;
142 bool m_keyHasBeenSet = false;
143
144 Aws::String m_versionId;
145 bool m_versionIdHasBeenSet = false;
146
147 RequestPayer m_requestPayer{RequestPayer::NOT_SET};
148 bool m_requestPayerHasBeenSet = false;
149
150 Aws::String m_expectedBucketOwner;
151 bool m_expectedBucketOwnerHasBeenSet = false;
152
153 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
154 bool m_customizedAccessLogTagHasBeenSet = false;
155 };
156
157} // namespace Model
158} // namespace S3
159} // namespace Aws
void SetCustomizedAccessLogTag(CustomizedAccessLogTagT &&value)
AWS_S3_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override
AWS_S3_API GetObjectRetentionRequest()=default
GetObjectRetentionRequest & WithBucket(BucketT &&value)
void SetExpectedBucketOwner(ExpectedBucketOwnerT &&value)
virtual const char * GetServiceRequestName() const override
GetObjectRetentionRequest & WithVersionId(VersionIdT &&value)
GetObjectRetentionRequest & WithExpectedBucketOwner(ExpectedBucketOwnerT &&value)
GetObjectRetentionRequest & AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT &&key, CustomizedAccessLogTagValueT &&value)
GetObjectRetentionRequest & WithRequestPayer(RequestPayer value)
AWS_S3_API EndpointParameters GetEndpointContextParams() const override
AWS_S3_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
GetObjectRetentionRequest & WithCustomizedAccessLogTag(CustomizedAccessLogTagT &&value)
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
GetObjectRetentionRequest & WithKey(KeyT &&value)
AWS_S3_API void AddQueryStringParameters(Aws::Http::URI &uri) const override
AWS_S3_API Aws::String SerializePayload() const override
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