AWS SDK for C++  1.9.160
AWS SDK for C++
StartMailboxExportJobRequest.h
Go to the documentation of this file.
1 
6 #pragma once
10 #include <utility>
11 #include <aws/core/utils/UUID.h>
12 
13 namespace Aws
14 {
15 namespace WorkMail
16 {
17 namespace Model
18 {
19 
23  {
24  public:
26 
27  // Service request name is the Operation name which will send this request out,
28  // each operation should has unique request name, so that we can get operation's name from this request.
29  // Note: this is not true for response, multiple operations may have the same response name,
30  // so we can not get operation's name from response.
31  inline virtual const char* GetServiceRequestName() const override { return "StartMailboxExportJob"; }
32 
33  Aws::String SerializePayload() const override;
34 
36 
37 
41  inline const Aws::String& GetClientToken() const{ return m_clientToken; }
42 
46  inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; }
47 
51  inline void SetClientToken(const Aws::String& value) { m_clientTokenHasBeenSet = true; m_clientToken = value; }
52 
56  inline void SetClientToken(Aws::String&& value) { m_clientTokenHasBeenSet = true; m_clientToken = std::move(value); }
57 
61  inline void SetClientToken(const char* value) { m_clientTokenHasBeenSet = true; m_clientToken.assign(value); }
62 
66  inline StartMailboxExportJobRequest& WithClientToken(const Aws::String& value) { SetClientToken(value); return *this;}
67 
71  inline StartMailboxExportJobRequest& WithClientToken(Aws::String&& value) { SetClientToken(std::move(value)); return *this;}
72 
76  inline StartMailboxExportJobRequest& WithClientToken(const char* value) { SetClientToken(value); return *this;}
77 
78 
82  inline const Aws::String& GetOrganizationId() const{ return m_organizationId; }
83 
87  inline bool OrganizationIdHasBeenSet() const { return m_organizationIdHasBeenSet; }
88 
92  inline void SetOrganizationId(const Aws::String& value) { m_organizationIdHasBeenSet = true; m_organizationId = value; }
93 
97  inline void SetOrganizationId(Aws::String&& value) { m_organizationIdHasBeenSet = true; m_organizationId = std::move(value); }
98 
102  inline void SetOrganizationId(const char* value) { m_organizationIdHasBeenSet = true; m_organizationId.assign(value); }
103 
107  inline StartMailboxExportJobRequest& WithOrganizationId(const Aws::String& value) { SetOrganizationId(value); return *this;}
108 
112  inline StartMailboxExportJobRequest& WithOrganizationId(Aws::String&& value) { SetOrganizationId(std::move(value)); return *this;}
113 
117  inline StartMailboxExportJobRequest& WithOrganizationId(const char* value) { SetOrganizationId(value); return *this;}
118 
119 
123  inline const Aws::String& GetEntityId() const{ return m_entityId; }
124 
128  inline bool EntityIdHasBeenSet() const { return m_entityIdHasBeenSet; }
129 
133  inline void SetEntityId(const Aws::String& value) { m_entityIdHasBeenSet = true; m_entityId = value; }
134 
138  inline void SetEntityId(Aws::String&& value) { m_entityIdHasBeenSet = true; m_entityId = std::move(value); }
139 
143  inline void SetEntityId(const char* value) { m_entityIdHasBeenSet = true; m_entityId.assign(value); }
144 
148  inline StartMailboxExportJobRequest& WithEntityId(const Aws::String& value) { SetEntityId(value); return *this;}
149 
153  inline StartMailboxExportJobRequest& WithEntityId(Aws::String&& value) { SetEntityId(std::move(value)); return *this;}
154 
158  inline StartMailboxExportJobRequest& WithEntityId(const char* value) { SetEntityId(value); return *this;}
159 
160 
164  inline const Aws::String& GetDescription() const{ return m_description; }
165 
169  inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
170 
174  inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; }
175 
179  inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); }
180 
184  inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); }
185 
189  inline StartMailboxExportJobRequest& WithDescription(const Aws::String& value) { SetDescription(value); return *this;}
190 
194  inline StartMailboxExportJobRequest& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;}
195 
199  inline StartMailboxExportJobRequest& WithDescription(const char* value) { SetDescription(value); return *this;}
200 
201 
206  inline const Aws::String& GetRoleArn() const{ return m_roleArn; }
207 
212  inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; }
213 
218  inline void SetRoleArn(const Aws::String& value) { m_roleArnHasBeenSet = true; m_roleArn = value; }
219 
224  inline void SetRoleArn(Aws::String&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::move(value); }
225 
230  inline void SetRoleArn(const char* value) { m_roleArnHasBeenSet = true; m_roleArn.assign(value); }
231 
236  inline StartMailboxExportJobRequest& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;}
237 
242  inline StartMailboxExportJobRequest& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;}
243 
248  inline StartMailboxExportJobRequest& WithRoleArn(const char* value) { SetRoleArn(value); return *this;}
249 
250 
255  inline const Aws::String& GetKmsKeyArn() const{ return m_kmsKeyArn; }
256 
261  inline bool KmsKeyArnHasBeenSet() const { return m_kmsKeyArnHasBeenSet; }
262 
267  inline void SetKmsKeyArn(const Aws::String& value) { m_kmsKeyArnHasBeenSet = true; m_kmsKeyArn = value; }
268 
273  inline void SetKmsKeyArn(Aws::String&& value) { m_kmsKeyArnHasBeenSet = true; m_kmsKeyArn = std::move(value); }
274 
279  inline void SetKmsKeyArn(const char* value) { m_kmsKeyArnHasBeenSet = true; m_kmsKeyArn.assign(value); }
280 
285  inline StartMailboxExportJobRequest& WithKmsKeyArn(const Aws::String& value) { SetKmsKeyArn(value); return *this;}
286 
291  inline StartMailboxExportJobRequest& WithKmsKeyArn(Aws::String&& value) { SetKmsKeyArn(std::move(value)); return *this;}
292 
297  inline StartMailboxExportJobRequest& WithKmsKeyArn(const char* value) { SetKmsKeyArn(value); return *this;}
298 
299 
303  inline const Aws::String& GetS3BucketName() const{ return m_s3BucketName; }
304 
308  inline bool S3BucketNameHasBeenSet() const { return m_s3BucketNameHasBeenSet; }
309 
313  inline void SetS3BucketName(const Aws::String& value) { m_s3BucketNameHasBeenSet = true; m_s3BucketName = value; }
314 
318  inline void SetS3BucketName(Aws::String&& value) { m_s3BucketNameHasBeenSet = true; m_s3BucketName = std::move(value); }
319 
323  inline void SetS3BucketName(const char* value) { m_s3BucketNameHasBeenSet = true; m_s3BucketName.assign(value); }
324 
328  inline StartMailboxExportJobRequest& WithS3BucketName(const Aws::String& value) { SetS3BucketName(value); return *this;}
329 
333  inline StartMailboxExportJobRequest& WithS3BucketName(Aws::String&& value) { SetS3BucketName(std::move(value)); return *this;}
334 
338  inline StartMailboxExportJobRequest& WithS3BucketName(const char* value) { SetS3BucketName(value); return *this;}
339 
340 
344  inline const Aws::String& GetS3Prefix() const{ return m_s3Prefix; }
345 
349  inline bool S3PrefixHasBeenSet() const { return m_s3PrefixHasBeenSet; }
350 
354  inline void SetS3Prefix(const Aws::String& value) { m_s3PrefixHasBeenSet = true; m_s3Prefix = value; }
355 
359  inline void SetS3Prefix(Aws::String&& value) { m_s3PrefixHasBeenSet = true; m_s3Prefix = std::move(value); }
360 
364  inline void SetS3Prefix(const char* value) { m_s3PrefixHasBeenSet = true; m_s3Prefix.assign(value); }
365 
369  inline StartMailboxExportJobRequest& WithS3Prefix(const Aws::String& value) { SetS3Prefix(value); return *this;}
370 
374  inline StartMailboxExportJobRequest& WithS3Prefix(Aws::String&& value) { SetS3Prefix(std::move(value)); return *this;}
375 
379  inline StartMailboxExportJobRequest& WithS3Prefix(const char* value) { SetS3Prefix(value); return *this;}
380 
381  private:
382 
383  Aws::String m_clientToken;
384  bool m_clientTokenHasBeenSet;
385 
386  Aws::String m_organizationId;
387  bool m_organizationIdHasBeenSet;
388 
389  Aws::String m_entityId;
390  bool m_entityIdHasBeenSet;
391 
392  Aws::String m_description;
393  bool m_descriptionHasBeenSet;
394 
395  Aws::String m_roleArn;
396  bool m_roleArnHasBeenSet;
397 
398  Aws::String m_kmsKeyArn;
399  bool m_kmsKeyArnHasBeenSet;
400 
401  Aws::String m_s3BucketName;
402  bool m_s3BucketNameHasBeenSet;
403 
404  Aws::String m_s3Prefix;
405  bool m_s3PrefixHasBeenSet;
406  };
407 
408 } // namespace Model
409 } // namespace WorkMail
410 } // namespace Aws
Aws::WorkMail::Model::StartMailboxExportJobRequest::GetOrganizationId
const Aws::String & GetOrganizationId() const
Definition: StartMailboxExportJobRequest.h:82
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithClientToken
StartMailboxExportJobRequest & WithClientToken(const Aws::String &value)
Definition: StartMailboxExportJobRequest.h:66
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetS3Prefix
void SetS3Prefix(const Aws::String &value)
Definition: StartMailboxExportJobRequest.h:354
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetKmsKeyArn
void SetKmsKeyArn(const char *value)
Definition: StartMailboxExportJobRequest.h:279
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithOrganizationId
StartMailboxExportJobRequest & WithOrganizationId(Aws::String &&value)
Definition: StartMailboxExportJobRequest.h:112
Aws::WorkMail::Model::StartMailboxExportJobRequest::KmsKeyArnHasBeenSet
bool KmsKeyArnHasBeenSet() const
Definition: StartMailboxExportJobRequest.h:261
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithS3Prefix
StartMailboxExportJobRequest & WithS3Prefix(const Aws::String &value)
Definition: StartMailboxExportJobRequest.h:369
Aws::WorkMail::Model::StartMailboxExportJobRequest::GetEntityId
const Aws::String & GetEntityId() const
Definition: StartMailboxExportJobRequest.h:123
Aws::WorkMail::Model::StartMailboxExportJobRequest::GetS3Prefix
const Aws::String & GetS3Prefix() const
Definition: StartMailboxExportJobRequest.h:344
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetOrganizationId
void SetOrganizationId(const char *value)
Definition: StartMailboxExportJobRequest.h:102
Aws::Http::HeaderValueCollection
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
Definition: HttpTypes.h:53
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetRoleArn
void SetRoleArn(Aws::String &&value)
Definition: StartMailboxExportJobRequest.h:224
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithS3BucketName
StartMailboxExportJobRequest & WithS3BucketName(Aws::String &&value)
Definition: StartMailboxExportJobRequest.h:333
Aws::WorkMail::Model::StartMailboxExportJobRequest::GetS3BucketName
const Aws::String & GetS3BucketName() const
Definition: StartMailboxExportJobRequest.h:303
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithS3BucketName
StartMailboxExportJobRequest & WithS3BucketName(const Aws::String &value)
Definition: StartMailboxExportJobRequest.h:328
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetDescription
void SetDescription(const char *value)
Definition: StartMailboxExportJobRequest.h:184
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetEntityId
void SetEntityId(Aws::String &&value)
Definition: StartMailboxExportJobRequest.h:138
Aws::WorkMail::Model::StartMailboxExportJobRequest::GetDescription
const Aws::String & GetDescription() const
Definition: StartMailboxExportJobRequest.h:164
Aws::WorkMail::WorkMailRequest
Definition: WorkMailRequest.h:17
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithEntityId
StartMailboxExportJobRequest & WithEntityId(const char *value)
Definition: StartMailboxExportJobRequest.h:158
Aws::WorkMail::Model::StartMailboxExportJobRequest::ClientTokenHasBeenSet
bool ClientTokenHasBeenSet() const
Definition: StartMailboxExportJobRequest.h:46
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithS3Prefix
StartMailboxExportJobRequest & WithS3Prefix(const char *value)
Definition: StartMailboxExportJobRequest.h:379
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithEntityId
StartMailboxExportJobRequest & WithEntityId(Aws::String &&value)
Definition: StartMailboxExportJobRequest.h:153
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetDescription
void SetDescription(const Aws::String &value)
Definition: StartMailboxExportJobRequest.h:174
WorkMail_EXPORTS.h
WorkMailRequest.h
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithRoleArn
StartMailboxExportJobRequest & WithRoleArn(const char *value)
Definition: StartMailboxExportJobRequest.h:248
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetDescription
void SetDescription(Aws::String &&value)
Definition: StartMailboxExportJobRequest.h:179
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetOrganizationId
void SetOrganizationId(const Aws::String &value)
Definition: StartMailboxExportJobRequest.h:92
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithS3BucketName
StartMailboxExportJobRequest & WithS3BucketName(const char *value)
Definition: StartMailboxExportJobRequest.h:338
Aws::WorkMail::Model::StartMailboxExportJobRequest
Definition: StartMailboxExportJobRequest.h:23
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetS3Prefix
void SetS3Prefix(const char *value)
Definition: StartMailboxExportJobRequest.h:364
Aws::WorkMail::Model::StartMailboxExportJobRequest::GetClientToken
const Aws::String & GetClientToken() const
Definition: StartMailboxExportJobRequest.h:41
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetS3BucketName
void SetS3BucketName(const char *value)
Definition: StartMailboxExportJobRequest.h:323
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetClientToken
void SetClientToken(const char *value)
Definition: StartMailboxExportJobRequest.h:61
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetS3BucketName
void SetS3BucketName(const Aws::String &value)
Definition: StartMailboxExportJobRequest.h:313
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetOrganizationId
void SetOrganizationId(Aws::String &&value)
Definition: StartMailboxExportJobRequest.h:97
Aws::WorkMail::Model::StartMailboxExportJobRequest::EntityIdHasBeenSet
bool EntityIdHasBeenSet() const
Definition: StartMailboxExportJobRequest.h:128
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetRoleArn
void SetRoleArn(const Aws::String &value)
Definition: StartMailboxExportJobRequest.h:218
Aws::WorkMail::Model::StartMailboxExportJobRequest::DescriptionHasBeenSet
bool DescriptionHasBeenSet() const
Definition: StartMailboxExportJobRequest.h:169
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetRoleArn
void SetRoleArn(const char *value)
Definition: StartMailboxExportJobRequest.h:230
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithOrganizationId
StartMailboxExportJobRequest & WithOrganizationId(const Aws::String &value)
Definition: StartMailboxExportJobRequest.h:107
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetKmsKeyArn
void SetKmsKeyArn(const Aws::String &value)
Definition: StartMailboxExportJobRequest.h:267
AWSString.h
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithDescription
StartMailboxExportJobRequest & WithDescription(Aws::String &&value)
Definition: StartMailboxExportJobRequest.h:194
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetS3BucketName
void SetS3BucketName(Aws::String &&value)
Definition: StartMailboxExportJobRequest.h:318
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetKmsKeyArn
void SetKmsKeyArn(Aws::String &&value)
Definition: StartMailboxExportJobRequest.h:273
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetEntityId
void SetEntityId(const char *value)
Definition: StartMailboxExportJobRequest.h:143
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetClientToken
void SetClientToken(const Aws::String &value)
Definition: StartMailboxExportJobRequest.h:51
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithDescription
StartMailboxExportJobRequest & WithDescription(const char *value)
Definition: StartMailboxExportJobRequest.h:199
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithRoleArn
StartMailboxExportJobRequest & WithRoleArn(const Aws::String &value)
Definition: StartMailboxExportJobRequest.h:236
Aws::WorkMail::Model::StartMailboxExportJobRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::WorkMail::Model::StartMailboxExportJobRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: StartMailboxExportJobRequest.h:31
Aws::WorkMail::Model::StartMailboxExportJobRequest::S3PrefixHasBeenSet
bool S3PrefixHasBeenSet() const
Definition: StartMailboxExportJobRequest.h:349
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithOrganizationId
StartMailboxExportJobRequest & WithOrganizationId(const char *value)
Definition: StartMailboxExportJobRequest.h:117
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetClientToken
void SetClientToken(Aws::String &&value)
Definition: StartMailboxExportJobRequest.h:56
Aws::WorkMail::Model::StartMailboxExportJobRequest::OrganizationIdHasBeenSet
bool OrganizationIdHasBeenSet() const
Definition: StartMailboxExportJobRequest.h:87
Aws
Definition: AccessManagementClient.h:15
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithEntityId
StartMailboxExportJobRequest & WithEntityId(const Aws::String &value)
Definition: StartMailboxExportJobRequest.h:148
AWS_WORKMAIL_API
#define AWS_WORKMAIL_API
Definition: WorkMail_EXPORTS.h:28
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithRoleArn
StartMailboxExportJobRequest & WithRoleArn(Aws::String &&value)
Definition: StartMailboxExportJobRequest.h:242
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithClientToken
StartMailboxExportJobRequest & WithClientToken(Aws::String &&value)
Definition: StartMailboxExportJobRequest.h:71
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithKmsKeyArn
StartMailboxExportJobRequest & WithKmsKeyArn(const char *value)
Definition: StartMailboxExportJobRequest.h:297
Aws::WorkMail::Model::StartMailboxExportJobRequest::GetRequestSpecificHeaders
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
Aws::WorkMail::Model::StartMailboxExportJobRequest::GetRoleArn
const Aws::String & GetRoleArn() const
Definition: StartMailboxExportJobRequest.h:206
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetS3Prefix
void SetS3Prefix(Aws::String &&value)
Definition: StartMailboxExportJobRequest.h:359
Aws::WorkMail::Model::StartMailboxExportJobRequest::S3BucketNameHasBeenSet
bool S3BucketNameHasBeenSet() const
Definition: StartMailboxExportJobRequest.h:308
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithKmsKeyArn
StartMailboxExportJobRequest & WithKmsKeyArn(Aws::String &&value)
Definition: StartMailboxExportJobRequest.h:291
Aws::WorkMail::Model::StartMailboxExportJobRequest::StartMailboxExportJobRequest
StartMailboxExportJobRequest()
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithDescription
StartMailboxExportJobRequest & WithDescription(const Aws::String &value)
Definition: StartMailboxExportJobRequest.h:189
UUID.h
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithS3Prefix
StartMailboxExportJobRequest & WithS3Prefix(Aws::String &&value)
Definition: StartMailboxExportJobRequest.h:374
Aws::WorkMail::Model::StartMailboxExportJobRequest::GetKmsKeyArn
const Aws::String & GetKmsKeyArn() const
Definition: StartMailboxExportJobRequest.h:255
Aws::WorkMail::Model::StartMailboxExportJobRequest::SetEntityId
void SetEntityId(const Aws::String &value)
Definition: StartMailboxExportJobRequest.h:133
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithKmsKeyArn
StartMailboxExportJobRequest & WithKmsKeyArn(const Aws::String &value)
Definition: StartMailboxExportJobRequest.h:285
Aws::WorkMail::Model::StartMailboxExportJobRequest::WithClientToken
StartMailboxExportJobRequest & WithClientToken(const char *value)
Definition: StartMailboxExportJobRequest.h:76
Aws::WorkMail::Model::StartMailboxExportJobRequest::RoleArnHasBeenSet
bool RoleArnHasBeenSet() const
Definition: StartMailboxExportJobRequest.h:212