AWS SDK for C++

AWS SDK for C++ Version 1.11.717

Loading...
Searching...
No Matches
ListObjectsResult.h
1
6#pragma once
7#include <aws/core/utils/memory/stl/AWSString.h>
8#include <aws/core/utils/memory/stl/AWSVector.h>
9#include <aws/s3/S3_EXPORTS.h>
10#include <aws/s3/model/CommonPrefix.h>
11#include <aws/s3/model/EncodingType.h>
12#include <aws/s3/model/Object.h>
13#include <aws/s3/model/RequestCharged.h>
14
15#include <utility>
16
17namespace Aws {
18template <typename RESULT_TYPE>
19class AmazonWebServiceResult;
20
21namespace Utils {
22namespace Xml {
23class XmlDocument;
24} // namespace Xml
25} // namespace Utils
26namespace S3 {
27namespace Model {
29 public:
30 AWS_S3_API ListObjectsResult() = default;
33
35
39 inline bool GetIsTruncated() const { return m_isTruncated; }
40 inline void SetIsTruncated(bool value) {
41 m_isTruncatedHasBeenSet = true;
42 m_isTruncated = value;
43 }
44 inline ListObjectsResult& WithIsTruncated(bool value) {
45 SetIsTruncated(value);
46 return *this;
47 }
49
51
55 inline const Aws::String& GetMarker() const { return m_marker; }
56 template <typename MarkerT = Aws::String>
57 void SetMarker(MarkerT&& value) {
58 m_markerHasBeenSet = true;
59 m_marker = std::forward<MarkerT>(value);
60 }
61 template <typename MarkerT = Aws::String>
62 ListObjectsResult& WithMarker(MarkerT&& value) {
63 SetMarker(std::forward<MarkerT>(value));
64 return *this;
65 }
67
69
81 inline const Aws::String& GetNextMarker() const { return m_nextMarker; }
82 template <typename NextMarkerT = Aws::String>
83 void SetNextMarker(NextMarkerT&& value) {
84 m_nextMarkerHasBeenSet = true;
85 m_nextMarker = std::forward<NextMarkerT>(value);
86 }
87 template <typename NextMarkerT = Aws::String>
88 ListObjectsResult& WithNextMarker(NextMarkerT&& value) {
89 SetNextMarker(std::forward<NextMarkerT>(value));
90 return *this;
91 }
93
95
98 inline const Aws::Vector<Object>& GetContents() const { return m_contents; }
99 template <typename ContentsT = Aws::Vector<Object>>
100 void SetContents(ContentsT&& value) {
101 m_contentsHasBeenSet = true;
102 m_contents = std::forward<ContentsT>(value);
103 }
104 template <typename ContentsT = Aws::Vector<Object>>
105 ListObjectsResult& WithContents(ContentsT&& value) {
106 SetContents(std::forward<ContentsT>(value));
107 return *this;
108 }
109 template <typename ContentsT = Object>
110 ListObjectsResult& AddContents(ContentsT&& value) {
111 m_contentsHasBeenSet = true;
112 m_contents.emplace_back(std::forward<ContentsT>(value));
113 return *this;
114 }
116
118
121 inline const Aws::String& GetName() const { return m_name; }
122 template <typename NameT = Aws::String>
123 void SetName(NameT&& value) {
124 m_nameHasBeenSet = true;
125 m_name = std::forward<NameT>(value);
126 }
127 template <typename NameT = Aws::String>
128 ListObjectsResult& WithName(NameT&& value) {
129 SetName(std::forward<NameT>(value));
130 return *this;
131 }
133
135
138 inline const Aws::String& GetPrefix() const { return m_prefix; }
139 template <typename PrefixT = Aws::String>
140 void SetPrefix(PrefixT&& value) {
141 m_prefixHasBeenSet = true;
142 m_prefix = std::forward<PrefixT>(value);
143 }
144 template <typename PrefixT = Aws::String>
145 ListObjectsResult& WithPrefix(PrefixT&& value) {
146 SetPrefix(std::forward<PrefixT>(value));
147 return *this;
148 }
150
152
159 inline const Aws::String& GetDelimiter() const { return m_delimiter; }
160 template <typename DelimiterT = Aws::String>
161 void SetDelimiter(DelimiterT&& value) {
162 m_delimiterHasBeenSet = true;
163 m_delimiter = std::forward<DelimiterT>(value);
164 }
165 template <typename DelimiterT = Aws::String>
166 ListObjectsResult& WithDelimiter(DelimiterT&& value) {
167 SetDelimiter(std::forward<DelimiterT>(value));
168 return *this;
169 }
171
173
176 inline int GetMaxKeys() const { return m_maxKeys; }
177 inline void SetMaxKeys(int value) {
178 m_maxKeysHasBeenSet = true;
179 m_maxKeys = value;
180 }
181 inline ListObjectsResult& WithMaxKeys(int value) {
182 SetMaxKeys(value);
183 return *this;
184 }
186
188
201 inline const Aws::Vector<CommonPrefix>& GetCommonPrefixes() const { return m_commonPrefixes; }
202 template <typename CommonPrefixesT = Aws::Vector<CommonPrefix>>
203 void SetCommonPrefixes(CommonPrefixesT&& value) {
204 m_commonPrefixesHasBeenSet = true;
205 m_commonPrefixes = std::forward<CommonPrefixesT>(value);
206 }
207 template <typename CommonPrefixesT = Aws::Vector<CommonPrefix>>
208 ListObjectsResult& WithCommonPrefixes(CommonPrefixesT&& value) {
209 SetCommonPrefixes(std::forward<CommonPrefixesT>(value));
210 return *this;
211 }
212 template <typename CommonPrefixesT = CommonPrefix>
213 ListObjectsResult& AddCommonPrefixes(CommonPrefixesT&& value) {
214 m_commonPrefixesHasBeenSet = true;
215 m_commonPrefixes.emplace_back(std::forward<CommonPrefixesT>(value));
216 return *this;
217 }
219
221
237 inline EncodingType GetEncodingType() const { return m_encodingType; }
238 inline void SetEncodingType(EncodingType value) {
239 m_encodingTypeHasBeenSet = true;
240 m_encodingType = value;
241 }
243 SetEncodingType(value);
244 return *this;
245 }
247
249
250 inline RequestCharged GetRequestCharged() const { return m_requestCharged; }
252 m_requestChargedHasBeenSet = true;
253 m_requestCharged = value;
254 }
256 SetRequestCharged(value);
257 return *this;
258 }
260
262
263 inline const Aws::String& GetRequestId() const { return m_requestId; }
264 template <typename RequestIdT = Aws::String>
265 void SetRequestId(RequestIdT&& value) {
266 m_requestIdHasBeenSet = true;
267 m_requestId = std::forward<RequestIdT>(value);
268 }
269 template <typename RequestIdT = Aws::String>
270 ListObjectsResult& WithRequestId(RequestIdT&& value) {
271 SetRequestId(std::forward<RequestIdT>(value));
272 return *this;
273 }
275 private:
276 bool m_isTruncated{false};
277
278 Aws::String m_marker;
279
280 Aws::String m_nextMarker;
281
282 Aws::Vector<Object> m_contents;
283
284 Aws::String m_name;
285
286 Aws::String m_prefix;
287
288 Aws::String m_delimiter;
289
290 int m_maxKeys{0};
291
292 Aws::Vector<CommonPrefix> m_commonPrefixes;
293
294 EncodingType m_encodingType{EncodingType::NOT_SET};
295
296 RequestCharged m_requestCharged{RequestCharged::NOT_SET};
297
298 Aws::String m_requestId;
299 bool m_isTruncatedHasBeenSet = false;
300 bool m_markerHasBeenSet = false;
301 bool m_nextMarkerHasBeenSet = false;
302 bool m_contentsHasBeenSet = false;
303 bool m_nameHasBeenSet = false;
304 bool m_prefixHasBeenSet = false;
305 bool m_delimiterHasBeenSet = false;
306 bool m_maxKeysHasBeenSet = false;
307 bool m_commonPrefixesHasBeenSet = false;
308 bool m_encodingTypeHasBeenSet = false;
309 bool m_requestChargedHasBeenSet = false;
310 bool m_requestIdHasBeenSet = false;
311};
312
313} // namespace Model
314} // namespace S3
315} // namespace Aws
const Aws::String & GetRequestId() const
ListObjectsResult & WithEncodingType(EncodingType value)
ListObjectsResult & AddCommonPrefixes(CommonPrefixesT &&value)
ListObjectsResult & WithMarker(MarkerT &&value)
const Aws::Vector< CommonPrefix > & GetCommonPrefixes() const
AWS_S3_API ListObjectsResult()=default
ListObjectsResult & WithName(NameT &&value)
void SetDelimiter(DelimiterT &&value)
ListObjectsResult & WithIsTruncated(bool value)
void SetCommonPrefixes(CommonPrefixesT &&value)
const Aws::String & GetDelimiter() const
const Aws::String & GetMarker() const
void SetEncodingType(EncodingType value)
const Aws::String & GetName() const
void SetContents(ContentsT &&value)
ListObjectsResult & WithDelimiter(DelimiterT &&value)
void SetRequestCharged(RequestCharged value)
ListObjectsResult & WithPrefix(PrefixT &&value)
ListObjectsResult & WithNextMarker(NextMarkerT &&value)
void SetNextMarker(NextMarkerT &&value)
const Aws::String & GetNextMarker() const
ListObjectsResult & WithMaxKeys(int value)
ListObjectsResult & WithRequestCharged(RequestCharged value)
void SetRequestId(RequestIdT &&value)
AWS_S3_API ListObjectsResult & operator=(const Aws::AmazonWebServiceResult< Aws::Utils::Xml::XmlDocument > &result)
ListObjectsResult & AddContents(ContentsT &&value)
ListObjectsResult & WithRequestId(RequestIdT &&value)
const Aws::String & GetPrefix() const
const Aws::Vector< Object > & GetContents() const
AWS_S3_API ListObjectsResult(const Aws::AmazonWebServiceResult< Aws::Utils::Xml::XmlDocument > &result)
ListObjectsResult & WithCommonPrefixes(CommonPrefixesT &&value)
ListObjectsResult & WithContents(ContentsT &&value)
RequestCharged GetRequestCharged() const
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector
Aws::Utils::Xml::XmlDocument XmlDocument