AWS SDK for C++
AWS SDK for C++
Loading...
Searching...
No Matches
S3Location.h
Go to the documentation of this file.
1
6#pragma once
7#include <aws/s3/S3_EXPORTS.h>
14#include <aws/s3/model/Grant.h>
16#include <utility>
17
18namespace Aws
19{
20namespace Utils
21{
22namespace Xml
23{
24 class XmlNode;
25} // namespace Xml
26} // namespace Utils
27namespace S3
28{
29namespace Model
30{
31
39 {
40 public:
44
46
47
51 inline const Aws::String& GetBucketName() const{ return m_bucketName; }
52
56 inline bool BucketNameHasBeenSet() const { return m_bucketNameHasBeenSet; }
57
61 inline void SetBucketName(const Aws::String& value) { m_bucketNameHasBeenSet = true; m_bucketName = value; }
62
66 inline void SetBucketName(Aws::String&& value) { m_bucketNameHasBeenSet = true; m_bucketName = std::move(value); }
67
71 inline void SetBucketName(const char* value) { m_bucketNameHasBeenSet = true; m_bucketName.assign(value); }
72
76 inline S3Location& WithBucketName(const Aws::String& value) { SetBucketName(value); return *this;}
77
81 inline S3Location& WithBucketName(Aws::String&& value) { SetBucketName(std::move(value)); return *this;}
82
86 inline S3Location& WithBucketName(const char* value) { SetBucketName(value); return *this;}
87
88
92 inline const Aws::String& GetPrefix() const{ return m_prefix; }
93
97 inline bool PrefixHasBeenSet() const { return m_prefixHasBeenSet; }
98
102 inline void SetPrefix(const Aws::String& value) { m_prefixHasBeenSet = true; m_prefix = value; }
103
107 inline void SetPrefix(Aws::String&& value) { m_prefixHasBeenSet = true; m_prefix = std::move(value); }
108
112 inline void SetPrefix(const char* value) { m_prefixHasBeenSet = true; m_prefix.assign(value); }
113
117 inline S3Location& WithPrefix(const Aws::String& value) { SetPrefix(value); return *this;}
118
122 inline S3Location& WithPrefix(Aws::String&& value) { SetPrefix(std::move(value)); return *this;}
123
127 inline S3Location& WithPrefix(const char* value) { SetPrefix(value); return *this;}
128
129
130
131 inline const Encryption& GetEncryption() const{ return m_encryption; }
132
133
134 inline bool EncryptionHasBeenSet() const { return m_encryptionHasBeenSet; }
135
136
137 inline void SetEncryption(const Encryption& value) { m_encryptionHasBeenSet = true; m_encryption = value; }
138
139
140 inline void SetEncryption(Encryption&& value) { m_encryptionHasBeenSet = true; m_encryption = std::move(value); }
141
142
143 inline S3Location& WithEncryption(const Encryption& value) { SetEncryption(value); return *this;}
144
145
146 inline S3Location& WithEncryption(Encryption&& value) { SetEncryption(std::move(value)); return *this;}
147
148
152 inline const ObjectCannedACL& GetCannedACL() const{ return m_cannedACL; }
153
157 inline bool CannedACLHasBeenSet() const { return m_cannedACLHasBeenSet; }
158
162 inline void SetCannedACL(const ObjectCannedACL& value) { m_cannedACLHasBeenSet = true; m_cannedACL = value; }
163
167 inline void SetCannedACL(ObjectCannedACL&& value) { m_cannedACLHasBeenSet = true; m_cannedACL = std::move(value); }
168
172 inline S3Location& WithCannedACL(const ObjectCannedACL& value) { SetCannedACL(value); return *this;}
173
177 inline S3Location& WithCannedACL(ObjectCannedACL&& value) { SetCannedACL(std::move(value)); return *this;}
178
179
183 inline const Aws::Vector<Grant>& GetAccessControlList() const{ return m_accessControlList; }
184
188 inline bool AccessControlListHasBeenSet() const { return m_accessControlListHasBeenSet; }
189
193 inline void SetAccessControlList(const Aws::Vector<Grant>& value) { m_accessControlListHasBeenSet = true; m_accessControlList = value; }
194
198 inline void SetAccessControlList(Aws::Vector<Grant>&& value) { m_accessControlListHasBeenSet = true; m_accessControlList = std::move(value); }
199
203 inline S3Location& WithAccessControlList(const Aws::Vector<Grant>& value) { SetAccessControlList(value); return *this;}
204
208 inline S3Location& WithAccessControlList(Aws::Vector<Grant>&& value) { SetAccessControlList(std::move(value)); return *this;}
209
213 inline S3Location& AddAccessControlList(const Grant& value) { m_accessControlListHasBeenSet = true; m_accessControlList.push_back(value); return *this; }
214
218 inline S3Location& AddAccessControlList(Grant&& value) { m_accessControlListHasBeenSet = true; m_accessControlList.push_back(std::move(value)); return *this; }
219
220
224 inline const Tagging& GetTagging() const{ return m_tagging; }
225
229 inline bool TaggingHasBeenSet() const { return m_taggingHasBeenSet; }
230
234 inline void SetTagging(const Tagging& value) { m_taggingHasBeenSet = true; m_tagging = value; }
235
239 inline void SetTagging(Tagging&& value) { m_taggingHasBeenSet = true; m_tagging = std::move(value); }
240
244 inline S3Location& WithTagging(const Tagging& value) { SetTagging(value); return *this;}
245
249 inline S3Location& WithTagging(Tagging&& value) { SetTagging(std::move(value)); return *this;}
250
251
255 inline const Aws::Vector<MetadataEntry>& GetUserMetadata() const{ return m_userMetadata; }
256
260 inline bool UserMetadataHasBeenSet() const { return m_userMetadataHasBeenSet; }
261
265 inline void SetUserMetadata(const Aws::Vector<MetadataEntry>& value) { m_userMetadataHasBeenSet = true; m_userMetadata = value; }
266
270 inline void SetUserMetadata(Aws::Vector<MetadataEntry>&& value) { m_userMetadataHasBeenSet = true; m_userMetadata = std::move(value); }
271
275 inline S3Location& WithUserMetadata(const Aws::Vector<MetadataEntry>& value) { SetUserMetadata(value); return *this;}
276
280 inline S3Location& WithUserMetadata(Aws::Vector<MetadataEntry>&& value) { SetUserMetadata(std::move(value)); return *this;}
281
285 inline S3Location& AddUserMetadata(const MetadataEntry& value) { m_userMetadataHasBeenSet = true; m_userMetadata.push_back(value); return *this; }
286
290 inline S3Location& AddUserMetadata(MetadataEntry&& value) { m_userMetadataHasBeenSet = true; m_userMetadata.push_back(std::move(value)); return *this; }
291
292
296 inline const StorageClass& GetStorageClass() const{ return m_storageClass; }
297
301 inline bool StorageClassHasBeenSet() const { return m_storageClassHasBeenSet; }
302
306 inline void SetStorageClass(const StorageClass& value) { m_storageClassHasBeenSet = true; m_storageClass = value; }
307
311 inline void SetStorageClass(StorageClass&& value) { m_storageClassHasBeenSet = true; m_storageClass = std::move(value); }
312
316 inline S3Location& WithStorageClass(const StorageClass& value) { SetStorageClass(value); return *this;}
317
321 inline S3Location& WithStorageClass(StorageClass&& value) { SetStorageClass(std::move(value)); return *this;}
322
323 private:
324
325 Aws::String m_bucketName;
326 bool m_bucketNameHasBeenSet = false;
327
328 Aws::String m_prefix;
329 bool m_prefixHasBeenSet = false;
330
331 Encryption m_encryption;
332 bool m_encryptionHasBeenSet = false;
333
334 ObjectCannedACL m_cannedACL;
335 bool m_cannedACLHasBeenSet = false;
336
337 Aws::Vector<Grant> m_accessControlList;
338 bool m_accessControlListHasBeenSet = false;
339
340 Tagging m_tagging;
341 bool m_taggingHasBeenSet = false;
342
343 Aws::Vector<MetadataEntry> m_userMetadata;
344 bool m_userMetadataHasBeenSet = false;
345
346 StorageClass m_storageClass;
347 bool m_storageClassHasBeenSet = false;
348 };
349
350} // namespace Model
351} // namespace S3
352} // namespace Aws
#define AWS_S3_API
Definition: S3_EXPORTS.h:28
Definition: MetadataEntry.h:31
const StorageClass & GetStorageClass() const
Definition: S3Location.h:296
void SetCannedACL(ObjectCannedACL &&value)
Definition: S3Location.h:167
S3Location & AddUserMetadata(const MetadataEntry &value)
Definition: S3Location.h:285
S3Location & WithUserMetadata(Aws::Vector< MetadataEntry > &&value)
Definition: S3Location.h:280
bool PrefixHasBeenSet() const
Definition: S3Location.h:97
S3Location & WithBucketName(const char *value)
Definition: S3Location.h:86
void SetAccessControlList(const Aws::Vector< Grant > &value)
Definition: S3Location.h:193
bool TaggingHasBeenSet() const
Definition: S3Location.h:229
void SetUserMetadata(const Aws::Vector< MetadataEntry > &value)
Definition: S3Location.h:265
S3Location & AddAccessControlList(Grant &&value)
Definition: S3Location.h:218
AWS_S3_API S3Location(const Aws::Utils::Xml::XmlNode &xmlNode)
void SetBucketName(Aws::String &&value)
Definition: S3Location.h:66
void SetBucketName(const char *value)
Definition: S3Location.h:71
S3Location & WithEncryption(const Encryption &value)
Definition: S3Location.h:143
bool AccessControlListHasBeenSet() const
Definition: S3Location.h:188
const Aws::String & GetPrefix() const
Definition: S3Location.h:92
S3Location & AddUserMetadata(MetadataEntry &&value)
Definition: S3Location.h:290
void SetStorageClass(const StorageClass &value)
Definition: S3Location.h:306
S3Location & WithPrefix(const Aws::String &value)
Definition: S3Location.h:117
S3Location & WithAccessControlList(const Aws::Vector< Grant > &value)
Definition: S3Location.h:203
void SetPrefix(const Aws::String &value)
Definition: S3Location.h:102
const ObjectCannedACL & GetCannedACL() const
Definition: S3Location.h:152
void SetTagging(const Tagging &value)
Definition: S3Location.h:234
AWS_S3_API S3Location & operator=(const Aws::Utils::Xml::XmlNode &xmlNode)
AWS_S3_API void AddToNode(Aws::Utils::Xml::XmlNode &parentNode) const
const Aws::Vector< Grant > & GetAccessControlList() const
Definition: S3Location.h:183
const Aws::String & GetBucketName() const
Definition: S3Location.h:51
bool EncryptionHasBeenSet() const
Definition: S3Location.h:134
S3Location & WithCannedACL(ObjectCannedACL &&value)
Definition: S3Location.h:177
bool CannedACLHasBeenSet() const
Definition: S3Location.h:157
S3Location & WithUserMetadata(const Aws::Vector< MetadataEntry > &value)
Definition: S3Location.h:275
bool BucketNameHasBeenSet() const
Definition: S3Location.h:56
bool StorageClassHasBeenSet() const
Definition: S3Location.h:301
S3Location & WithAccessControlList(Aws::Vector< Grant > &&value)
Definition: S3Location.h:208
void SetEncryption(const Encryption &value)
Definition: S3Location.h:137
S3Location & WithTagging(const Tagging &value)
Definition: S3Location.h:244
S3Location & WithTagging(Tagging &&value)
Definition: S3Location.h:249
S3Location & WithEncryption(Encryption &&value)
Definition: S3Location.h:146
void SetEncryption(Encryption &&value)
Definition: S3Location.h:140
void SetPrefix(Aws::String &&value)
Definition: S3Location.h:107
const Tagging & GetTagging() const
Definition: S3Location.h:224
void SetBucketName(const Aws::String &value)
Definition: S3Location.h:61
void SetStorageClass(StorageClass &&value)
Definition: S3Location.h:311
S3Location & WithBucketName(Aws::String &&value)
Definition: S3Location.h:81
S3Location & AddAccessControlList(const Grant &value)
Definition: S3Location.h:213
const Aws::Vector< MetadataEntry > & GetUserMetadata() const
Definition: S3Location.h:255
S3Location & WithStorageClass(StorageClass &&value)
Definition: S3Location.h:321
const Encryption & GetEncryption() const
Definition: S3Location.h:131
void SetCannedACL(const ObjectCannedACL &value)
Definition: S3Location.h:162
void SetUserMetadata(Aws::Vector< MetadataEntry > &&value)
Definition: S3Location.h:270
S3Location & WithPrefix(Aws::String &&value)
Definition: S3Location.h:122
S3Location & WithBucketName(const Aws::String &value)
Definition: S3Location.h:76
void SetAccessControlList(Aws::Vector< Grant > &&value)
Definition: S3Location.h:198
bool UserMetadataHasBeenSet() const
Definition: S3Location.h:260
void SetTagging(Tagging &&value)
Definition: S3Location.h:239
S3Location & WithCannedACL(const ObjectCannedACL &value)
Definition: S3Location.h:172
S3Location & WithPrefix(const char *value)
Definition: S3Location.h:127
S3Location & WithStorageClass(const StorageClass &value)
Definition: S3Location.h:316
void SetPrefix(const char *value)
Definition: S3Location.h:112
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector