AWS SDK for C++  1.9.15
AWS SDK for C++
GetObjectLegalHoldRequest.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>
12 #include <utility>
13 
14 namespace Aws
15 {
16 namespace Http
17 {
18  class URI;
19 } //namespace Http
20 namespace S3
21 {
22 namespace 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 "GetObjectLegalHold"; }
37 
38  Aws::String SerializePayload() const override;
39 
40  void AddQueryStringParameters(Aws::Http::URI& uri) const override;
41 
43 
44 
56  inline const Aws::String& GetBucket() const{ return m_bucket; }
57 
69  inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
70 
82  inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; }
83 
95  inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); }
96 
108  inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); }
109 
121  inline GetObjectLegalHoldRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;}
122 
134  inline GetObjectLegalHoldRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;}
135 
147  inline GetObjectLegalHoldRequest& WithBucket(const char* value) { SetBucket(value); return *this;}
148 
149 
153  inline const Aws::String& GetKey() const{ return m_key; }
154 
158  inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
159 
163  inline void SetKey(const Aws::String& value) { m_keyHasBeenSet = true; m_key = value; }
164 
168  inline void SetKey(Aws::String&& value) { m_keyHasBeenSet = true; m_key = std::move(value); }
169 
173  inline void SetKey(const char* value) { m_keyHasBeenSet = true; m_key.assign(value); }
174 
178  inline GetObjectLegalHoldRequest& WithKey(const Aws::String& value) { SetKey(value); return *this;}
179 
183  inline GetObjectLegalHoldRequest& WithKey(Aws::String&& value) { SetKey(std::move(value)); return *this;}
184 
188  inline GetObjectLegalHoldRequest& WithKey(const char* value) { SetKey(value); return *this;}
189 
190 
195  inline const Aws::String& GetVersionId() const{ return m_versionId; }
196 
201  inline bool VersionIdHasBeenSet() const { return m_versionIdHasBeenSet; }
202 
207  inline void SetVersionId(const Aws::String& value) { m_versionIdHasBeenSet = true; m_versionId = value; }
208 
213  inline void SetVersionId(Aws::String&& value) { m_versionIdHasBeenSet = true; m_versionId = std::move(value); }
214 
219  inline void SetVersionId(const char* value) { m_versionIdHasBeenSet = true; m_versionId.assign(value); }
220 
225  inline GetObjectLegalHoldRequest& WithVersionId(const Aws::String& value) { SetVersionId(value); return *this;}
226 
231  inline GetObjectLegalHoldRequest& WithVersionId(Aws::String&& value) { SetVersionId(std::move(value)); return *this;}
232 
237  inline GetObjectLegalHoldRequest& WithVersionId(const char* value) { SetVersionId(value); return *this;}
238 
239 
240 
241  inline const RequestPayer& GetRequestPayer() const{ return m_requestPayer; }
242 
243 
244  inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
245 
246 
247  inline void SetRequestPayer(const RequestPayer& value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; }
248 
249 
250  inline void SetRequestPayer(RequestPayer&& value) { m_requestPayerHasBeenSet = true; m_requestPayer = std::move(value); }
251 
252 
253  inline GetObjectLegalHoldRequest& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;}
254 
255 
256  inline GetObjectLegalHoldRequest& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;}
257 
258 
264  inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; }
265 
271  inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
272 
278  inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; }
279 
285  inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); }
286 
292  inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); }
293 
299  inline GetObjectLegalHoldRequest& WithExpectedBucketOwner(const Aws::String& value) { SetExpectedBucketOwner(value); return *this;}
300 
306  inline GetObjectLegalHoldRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;}
307 
313  inline GetObjectLegalHoldRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;}
314 
315 
316 
317  inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; }
318 
319 
320  inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
321 
322 
323  inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; }
324 
325 
326  inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); }
327 
328 
329  inline GetObjectLegalHoldRequest& WithCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { SetCustomizedAccessLogTag(value); return *this;}
330 
331 
332  inline GetObjectLegalHoldRequest& WithCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { SetCustomizedAccessLogTag(std::move(value)); return *this;}
333 
334 
335  inline GetObjectLegalHoldRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
336 
337 
338  inline GetObjectLegalHoldRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
339 
340 
341  inline GetObjectLegalHoldRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
342 
343 
344  inline GetObjectLegalHoldRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; }
345 
346 
347  inline GetObjectLegalHoldRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
348 
349 
350  inline GetObjectLegalHoldRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
351 
352 
353  inline GetObjectLegalHoldRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
354 
355  private:
356 
357  Aws::String m_bucket;
358  bool m_bucketHasBeenSet;
359 
360  Aws::String m_key;
361  bool m_keyHasBeenSet;
362 
363  Aws::String m_versionId;
364  bool m_versionIdHasBeenSet;
365 
366  RequestPayer m_requestPayer;
367  bool m_requestPayerHasBeenSet;
368 
369  Aws::String m_expectedBucketOwner;
370  bool m_expectedBucketOwnerHasBeenSet;
371 
372  Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
373  bool m_customizedAccessLogTagHasBeenSet;
374  };
375 
376 } // namespace Model
377 } // namespace S3
378 } // namespace Aws
Aws::Http::URI
Definition: URI.h:32
Aws::Http::HeaderValueCollection
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
Definition: HttpTypes.h:53
S3Request.h
S3_EXPORTS.h
AWS_S3_API
#define AWS_S3_API
Definition: S3_EXPORTS.h:28
Aws::S3::Model::RequestPayer
RequestPayer
Definition: RequestPayer.h:17
Aws::S3::S3Request
Definition: S3Request.h:18
AWSString.h
RequestPayer.h
Aws
Definition: AccessManagementClient.h:15
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
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