AWS SDK for C++

AWS SDK for C++ Version 1.11.440

Loading...
Searching...
No Matches
ListBucketsRequest.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/memory/stl/AWSMap.h>
11#include <utility>
12
13namespace Aws
14{
15namespace Http
16{
17 class URI;
18} //namespace Http
19namespace S3
20{
21namespace Model
22{
23
27 {
28 public:
29 AWS_S3_API ListBucketsRequest();
30
31 // Service request name is the Operation name which will send this request out,
32 // each operation should has unique request name, so that we can get operation's name from this request.
33 // Note: this is not true for response, multiple operations may have the same response name,
34 // so we can not get operation's name from response.
35 inline virtual const char* GetServiceRequestName() const override { return "ListBuckets"; }
36
37 AWS_S3_API Aws::String SerializePayload() const override;
38
39 AWS_S3_API void AddQueryStringParameters(Aws::Http::URI& uri) const override;
40
41 AWS_S3_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override;
42
44
49 inline int GetMaxBuckets() const{ return m_maxBuckets; }
50 inline bool MaxBucketsHasBeenSet() const { return m_maxBucketsHasBeenSet; }
51 inline void SetMaxBuckets(int value) { m_maxBucketsHasBeenSet = true; m_maxBuckets = value; }
52 inline ListBucketsRequest& WithMaxBuckets(int value) { SetMaxBuckets(value); return *this;}
54
56
64 inline const Aws::String& GetContinuationToken() const{ return m_continuationToken; }
65 inline bool ContinuationTokenHasBeenSet() const { return m_continuationTokenHasBeenSet; }
66 inline void SetContinuationToken(const Aws::String& value) { m_continuationTokenHasBeenSet = true; m_continuationToken = value; }
67 inline void SetContinuationToken(Aws::String&& value) { m_continuationTokenHasBeenSet = true; m_continuationToken = std::move(value); }
68 inline void SetContinuationToken(const char* value) { m_continuationTokenHasBeenSet = true; m_continuationToken.assign(value); }
69 inline ListBucketsRequest& WithContinuationToken(const Aws::String& value) { SetContinuationToken(value); return *this;}
70 inline ListBucketsRequest& WithContinuationToken(Aws::String&& value) { SetContinuationToken(std::move(value)); return *this;}
71 inline ListBucketsRequest& WithContinuationToken(const char* value) { SetContinuationToken(value); return *this;}
73
75
79 inline const Aws::String& GetPrefix() const{ return m_prefix; }
80 inline bool PrefixHasBeenSet() const { return m_prefixHasBeenSet; }
81 inline void SetPrefix(const Aws::String& value) { m_prefixHasBeenSet = true; m_prefix = value; }
82 inline void SetPrefix(Aws::String&& value) { m_prefixHasBeenSet = true; m_prefix = std::move(value); }
83 inline void SetPrefix(const char* value) { m_prefixHasBeenSet = true; m_prefix.assign(value); }
84 inline ListBucketsRequest& WithPrefix(const Aws::String& value) { SetPrefix(value); return *this;}
85 inline ListBucketsRequest& WithPrefix(Aws::String&& value) { SetPrefix(std::move(value)); return *this;}
86 inline ListBucketsRequest& WithPrefix(const char* value) { SetPrefix(value); return *this;}
88
90
103 inline const Aws::String& GetBucketRegion() const{ return m_bucketRegion; }
104 inline bool BucketRegionHasBeenSet() const { return m_bucketRegionHasBeenSet; }
105 inline void SetBucketRegion(const Aws::String& value) { m_bucketRegionHasBeenSet = true; m_bucketRegion = value; }
106 inline void SetBucketRegion(Aws::String&& value) { m_bucketRegionHasBeenSet = true; m_bucketRegion = std::move(value); }
107 inline void SetBucketRegion(const char* value) { m_bucketRegionHasBeenSet = true; m_bucketRegion.assign(value); }
108 inline ListBucketsRequest& WithBucketRegion(const Aws::String& value) { SetBucketRegion(value); return *this;}
109 inline ListBucketsRequest& WithBucketRegion(Aws::String&& value) { SetBucketRegion(std::move(value)); return *this;}
110 inline ListBucketsRequest& WithBucketRegion(const char* value) { SetBucketRegion(value); return *this;}
112
114
115 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; }
116 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
117 inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; }
118 inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); }
121 inline ListBucketsRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
122 inline ListBucketsRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
123 inline ListBucketsRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
124 inline ListBucketsRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; }
125 inline ListBucketsRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
126 inline ListBucketsRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
127 inline ListBucketsRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
129 private:
130
131 int m_maxBuckets;
132 bool m_maxBucketsHasBeenSet = false;
133
134 Aws::String m_continuationToken;
135 bool m_continuationTokenHasBeenSet = false;
136
137 Aws::String m_prefix;
138 bool m_prefixHasBeenSet = false;
139
140 Aws::String m_bucketRegion;
141 bool m_bucketRegionHasBeenSet = false;
142
143 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
144 bool m_customizedAccessLogTagHasBeenSet = false;
145 };
146
147} // namespace Model
148} // namespace S3
149} // namespace Aws
void SetCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
AWS_S3_API Aws::String SerializePayload() const override
ListBucketsRequest & WithMaxBuckets(int value)
ListBucketsRequest & WithPrefix(Aws::String &&value)
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
ListBucketsRequest & AddCustomizedAccessLogTag(const Aws::String &key, Aws::String &&value)
ListBucketsRequest & WithCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
void SetCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
ListBucketsRequest & AddCustomizedAccessLogTag(Aws::String &&key, const Aws::String &value)
const Aws::String & GetContinuationToken() const
void SetContinuationToken(const char *value)
void SetBucketRegion(const Aws::String &value)
ListBucketsRequest & WithPrefix(const Aws::String &value)
ListBucketsRequest & AddCustomizedAccessLogTag(Aws::String &&key, Aws::String &&value)
ListBucketsRequest & AddCustomizedAccessLogTag(const char *key, const char *value)
void SetContinuationToken(const Aws::String &value)
ListBucketsRequest & AddCustomizedAccessLogTag(const char *key, Aws::String &&value)
AWS_S3_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override
ListBucketsRequest & WithBucketRegion(Aws::String &&value)
void SetBucketRegion(const char *value)
virtual const char * GetServiceRequestName() const override
void SetBucketRegion(Aws::String &&value)
const Aws::String & GetBucketRegion() const
void SetContinuationToken(Aws::String &&value)
ListBucketsRequest & AddCustomizedAccessLogTag(const Aws::String &key, const Aws::String &value)
ListBucketsRequest & WithPrefix(const char *value)
AWS_S3_API void AddQueryStringParameters(Aws::Http::URI &uri) const override
ListBucketsRequest & WithContinuationToken(Aws::String &&value)
ListBucketsRequest & WithBucketRegion(const Aws::String &value)
void SetPrefix(const Aws::String &value)
ListBucketsRequest & WithCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
ListBucketsRequest & WithContinuationToken(const char *value)
ListBucketsRequest & WithContinuationToken(const Aws::String &value)
ListBucketsRequest & AddCustomizedAccessLogTag(Aws::String &&key, const char *value)
void SetPrefix(Aws::String &&value)
ListBucketsRequest & WithBucketRegion(const char *value)
const Aws::String & GetPrefix() const
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