AWS SDK for C++

AWS SDK for C++ Version 1.11.440

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:
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
65 inline const Aws::String& GetBucket() const{ return m_bucket; }
66 inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
67 inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; }
68 inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); }
69 inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); }
70 inline GetObjectRetentionRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;}
71 inline GetObjectRetentionRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;}
72 inline GetObjectRetentionRequest& WithBucket(const char* value) { SetBucket(value); return *this;}
74
76
80 inline const Aws::String& GetKey() const{ return m_key; }
81 inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
82 inline void SetKey(const Aws::String& value) { m_keyHasBeenSet = true; m_key = value; }
83 inline void SetKey(Aws::String&& value) { m_keyHasBeenSet = true; m_key = std::move(value); }
84 inline void SetKey(const char* value) { m_keyHasBeenSet = true; m_key.assign(value); }
85 inline GetObjectRetentionRequest& WithKey(const Aws::String& value) { SetKey(value); return *this;}
86 inline GetObjectRetentionRequest& WithKey(Aws::String&& value) { SetKey(std::move(value)); return *this;}
87 inline GetObjectRetentionRequest& WithKey(const char* value) { SetKey(value); return *this;}
89
91
95 inline const Aws::String& GetVersionId() const{ return m_versionId; }
96 inline bool VersionIdHasBeenSet() const { return m_versionIdHasBeenSet; }
97 inline void SetVersionId(const Aws::String& value) { m_versionIdHasBeenSet = true; m_versionId = value; }
98 inline void SetVersionId(Aws::String&& value) { m_versionIdHasBeenSet = true; m_versionId = std::move(value); }
99 inline void SetVersionId(const char* value) { m_versionIdHasBeenSet = true; m_versionId.assign(value); }
100 inline GetObjectRetentionRequest& WithVersionId(const Aws::String& value) { SetVersionId(value); return *this;}
101 inline GetObjectRetentionRequest& WithVersionId(Aws::String&& value) { SetVersionId(std::move(value)); return *this;}
102 inline GetObjectRetentionRequest& WithVersionId(const char* value) { SetVersionId(value); return *this;}
104
106
107 inline const RequestPayer& GetRequestPayer() const{ return m_requestPayer; }
108 inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
109 inline void SetRequestPayer(const RequestPayer& value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; }
110 inline void SetRequestPayer(RequestPayer&& value) { m_requestPayerHasBeenSet = true; m_requestPayer = std::move(value); }
111 inline GetObjectRetentionRequest& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;}
112 inline GetObjectRetentionRequest& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;}
114
116
121 inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; }
122 inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
123 inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; }
124 inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); }
125 inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); }
127 inline GetObjectRetentionRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;}
128 inline GetObjectRetentionRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;}
130
132
133 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; }
134 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
135 inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; }
136 inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); }
139 inline GetObjectRetentionRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
140 inline GetObjectRetentionRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
141 inline GetObjectRetentionRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
142 inline GetObjectRetentionRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; }
143 inline GetObjectRetentionRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
144 inline GetObjectRetentionRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
145 inline GetObjectRetentionRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
147 private:
148
149 Aws::String m_bucket;
150 bool m_bucketHasBeenSet = false;
151
152 Aws::String m_key;
153 bool m_keyHasBeenSet = false;
154
155 Aws::String m_versionId;
156 bool m_versionIdHasBeenSet = false;
157
158 RequestPayer m_requestPayer;
159 bool m_requestPayerHasBeenSet = false;
160
161 Aws::String m_expectedBucketOwner;
162 bool m_expectedBucketOwnerHasBeenSet = false;
163
164 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
165 bool m_customizedAccessLogTagHasBeenSet = false;
166 };
167
168} // namespace Model
169} // namespace S3
170} // namespace Aws
AWS_S3_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override
GetObjectRetentionRequest & AddCustomizedAccessLogTag(const Aws::String &key, const Aws::String &value)
void SetCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
GetObjectRetentionRequest & AddCustomizedAccessLogTag(const char *key, const char *value)
GetObjectRetentionRequest & WithVersionId(Aws::String &&value)
GetObjectRetentionRequest & WithExpectedBucketOwner(const Aws::String &value)
GetObjectRetentionRequest & WithCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
GetObjectRetentionRequest & AddCustomizedAccessLogTag(Aws::String &&key, const Aws::String &value)
GetObjectRetentionRequest & WithRequestPayer(const RequestPayer &value)
GetObjectRetentionRequest & WithBucket(Aws::String &&value)
void SetExpectedBucketOwner(const Aws::String &value)
virtual const char * GetServiceRequestName() const override
GetObjectRetentionRequest & WithVersionId(const Aws::String &value)
GetObjectRetentionRequest & WithRequestPayer(RequestPayer &&value)
GetObjectRetentionRequest & WithBucket(const Aws::String &value)
void SetCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
GetObjectRetentionRequest & AddCustomizedAccessLogTag(const Aws::String &key, Aws::String &&value)
GetObjectRetentionRequest & AddCustomizedAccessLogTag(const char *key, Aws::String &&value)
AWS_S3_API EndpointParameters GetEndpointContextParams() const override
AWS_S3_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
GetObjectRetentionRequest & WithExpectedBucketOwner(Aws::String &&value)
GetObjectRetentionRequest & WithBucket(const char *value)
GetObjectRetentionRequest & WithKey(Aws::String &&value)
GetObjectRetentionRequest & WithVersionId(const char *value)
GetObjectRetentionRequest & WithKey(const Aws::String &value)
GetObjectRetentionRequest & AddCustomizedAccessLogTag(Aws::String &&key, const char *value)
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
GetObjectRetentionRequest & WithCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
GetObjectRetentionRequest & AddCustomizedAccessLogTag(Aws::String &&key, Aws::String &&value)
GetObjectRetentionRequest & WithExpectedBucketOwner(const char *value)
GetObjectRetentionRequest & WithKey(const char *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