AWS SDK for C++  1.9.16
AWS SDK for C++
CreatePortalRequest.h
Go to the documentation of this file.
1 
6 #pragma once
13 #include <utility>
14 #include <aws/core/utils/UUID.h>
15 
16 namespace Aws
17 {
18 namespace IoTSiteWise
19 {
20 namespace Model
21 {
22 
26  {
27  public:
29 
30  // Service request name is the Operation name which will send this request out,
31  // each operation should has unique request name, so that we can get operation's name from this request.
32  // Note: this is not true for response, multiple operations may have the same response name,
33  // so we can not get operation's name from response.
34  inline virtual const char* GetServiceRequestName() const override { return "CreatePortal"; }
35 
36  Aws::String SerializePayload() const override;
37 
38 
42  inline const Aws::String& GetPortalName() const{ return m_portalName; }
43 
47  inline bool PortalNameHasBeenSet() const { return m_portalNameHasBeenSet; }
48 
52  inline void SetPortalName(const Aws::String& value) { m_portalNameHasBeenSet = true; m_portalName = value; }
53 
57  inline void SetPortalName(Aws::String&& value) { m_portalNameHasBeenSet = true; m_portalName = std::move(value); }
58 
62  inline void SetPortalName(const char* value) { m_portalNameHasBeenSet = true; m_portalName.assign(value); }
63 
67  inline CreatePortalRequest& WithPortalName(const Aws::String& value) { SetPortalName(value); return *this;}
68 
72  inline CreatePortalRequest& WithPortalName(Aws::String&& value) { SetPortalName(std::move(value)); return *this;}
73 
77  inline CreatePortalRequest& WithPortalName(const char* value) { SetPortalName(value); return *this;}
78 
79 
83  inline const Aws::String& GetPortalDescription() const{ return m_portalDescription; }
84 
88  inline bool PortalDescriptionHasBeenSet() const { return m_portalDescriptionHasBeenSet; }
89 
93  inline void SetPortalDescription(const Aws::String& value) { m_portalDescriptionHasBeenSet = true; m_portalDescription = value; }
94 
98  inline void SetPortalDescription(Aws::String&& value) { m_portalDescriptionHasBeenSet = true; m_portalDescription = std::move(value); }
99 
103  inline void SetPortalDescription(const char* value) { m_portalDescriptionHasBeenSet = true; m_portalDescription.assign(value); }
104 
108  inline CreatePortalRequest& WithPortalDescription(const Aws::String& value) { SetPortalDescription(value); return *this;}
109 
113  inline CreatePortalRequest& WithPortalDescription(Aws::String&& value) { SetPortalDescription(std::move(value)); return *this;}
114 
118  inline CreatePortalRequest& WithPortalDescription(const char* value) { SetPortalDescription(value); return *this;}
119 
120 
124  inline const Aws::String& GetPortalContactEmail() const{ return m_portalContactEmail; }
125 
129  inline bool PortalContactEmailHasBeenSet() const { return m_portalContactEmailHasBeenSet; }
130 
134  inline void SetPortalContactEmail(const Aws::String& value) { m_portalContactEmailHasBeenSet = true; m_portalContactEmail = value; }
135 
139  inline void SetPortalContactEmail(Aws::String&& value) { m_portalContactEmailHasBeenSet = true; m_portalContactEmail = std::move(value); }
140 
144  inline void SetPortalContactEmail(const char* value) { m_portalContactEmailHasBeenSet = true; m_portalContactEmail.assign(value); }
145 
149  inline CreatePortalRequest& WithPortalContactEmail(const Aws::String& value) { SetPortalContactEmail(value); return *this;}
150 
154  inline CreatePortalRequest& WithPortalContactEmail(Aws::String&& value) { SetPortalContactEmail(std::move(value)); return *this;}
155 
159  inline CreatePortalRequest& WithPortalContactEmail(const char* value) { SetPortalContactEmail(value); return *this;}
160 
161 
167  inline const Aws::String& GetClientToken() const{ return m_clientToken; }
168 
174  inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; }
175 
181  inline void SetClientToken(const Aws::String& value) { m_clientTokenHasBeenSet = true; m_clientToken = value; }
182 
188  inline void SetClientToken(Aws::String&& value) { m_clientTokenHasBeenSet = true; m_clientToken = std::move(value); }
189 
195  inline void SetClientToken(const char* value) { m_clientTokenHasBeenSet = true; m_clientToken.assign(value); }
196 
202  inline CreatePortalRequest& WithClientToken(const Aws::String& value) { SetClientToken(value); return *this;}
203 
209  inline CreatePortalRequest& WithClientToken(Aws::String&& value) { SetClientToken(std::move(value)); return *this;}
210 
216  inline CreatePortalRequest& WithClientToken(const char* value) { SetClientToken(value); return *this;}
217 
218 
223  inline const ImageFile& GetPortalLogoImageFile() const{ return m_portalLogoImageFile; }
224 
229  inline bool PortalLogoImageFileHasBeenSet() const { return m_portalLogoImageFileHasBeenSet; }
230 
235  inline void SetPortalLogoImageFile(const ImageFile& value) { m_portalLogoImageFileHasBeenSet = true; m_portalLogoImageFile = value; }
236 
241  inline void SetPortalLogoImageFile(ImageFile&& value) { m_portalLogoImageFileHasBeenSet = true; m_portalLogoImageFile = std::move(value); }
242 
247  inline CreatePortalRequest& WithPortalLogoImageFile(const ImageFile& value) { SetPortalLogoImageFile(value); return *this;}
248 
253  inline CreatePortalRequest& WithPortalLogoImageFile(ImageFile&& value) { SetPortalLogoImageFile(std::move(value)); return *this;}
254 
255 
265  inline const Aws::String& GetRoleArn() const{ return m_roleArn; }
266 
276  inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; }
277 
287  inline void SetRoleArn(const Aws::String& value) { m_roleArnHasBeenSet = true; m_roleArn = value; }
288 
298  inline void SetRoleArn(Aws::String&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::move(value); }
299 
309  inline void SetRoleArn(const char* value) { m_roleArnHasBeenSet = true; m_roleArn.assign(value); }
310 
320  inline CreatePortalRequest& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;}
321 
331  inline CreatePortalRequest& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;}
332 
342  inline CreatePortalRequest& WithRoleArn(const char* value) { SetRoleArn(value); return *this;}
343 
344 
352  inline const Aws::Map<Aws::String, Aws::String>& GetTags() const{ return m_tags; }
353 
361  inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
362 
370  inline void SetTags(const Aws::Map<Aws::String, Aws::String>& value) { m_tagsHasBeenSet = true; m_tags = value; }
371 
379  inline void SetTags(Aws::Map<Aws::String, Aws::String>&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); }
380 
388  inline CreatePortalRequest& WithTags(const Aws::Map<Aws::String, Aws::String>& value) { SetTags(value); return *this;}
389 
397  inline CreatePortalRequest& WithTags(Aws::Map<Aws::String, Aws::String>&& value) { SetTags(std::move(value)); return *this;}
398 
406  inline CreatePortalRequest& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; }
407 
415  inline CreatePortalRequest& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; }
416 
424  inline CreatePortalRequest& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; }
425 
433  inline CreatePortalRequest& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; }
434 
442  inline CreatePortalRequest& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; }
443 
451  inline CreatePortalRequest& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; }
452 
460  inline CreatePortalRequest& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; }
461 
462 
477  inline const AuthMode& GetPortalAuthMode() const{ return m_portalAuthMode; }
478 
493  inline bool PortalAuthModeHasBeenSet() const { return m_portalAuthModeHasBeenSet; }
494 
509  inline void SetPortalAuthMode(const AuthMode& value) { m_portalAuthModeHasBeenSet = true; m_portalAuthMode = value; }
510 
525  inline void SetPortalAuthMode(AuthMode&& value) { m_portalAuthModeHasBeenSet = true; m_portalAuthMode = std::move(value); }
526 
541  inline CreatePortalRequest& WithPortalAuthMode(const AuthMode& value) { SetPortalAuthMode(value); return *this;}
542 
557  inline CreatePortalRequest& WithPortalAuthMode(AuthMode&& value) { SetPortalAuthMode(std::move(value)); return *this;}
558 
559  private:
560 
561  Aws::String m_portalName;
562  bool m_portalNameHasBeenSet;
563 
564  Aws::String m_portalDescription;
565  bool m_portalDescriptionHasBeenSet;
566 
567  Aws::String m_portalContactEmail;
568  bool m_portalContactEmailHasBeenSet;
569 
570  Aws::String m_clientToken;
571  bool m_clientTokenHasBeenSet;
572 
573  ImageFile m_portalLogoImageFile;
574  bool m_portalLogoImageFileHasBeenSet;
575 
576  Aws::String m_roleArn;
577  bool m_roleArnHasBeenSet;
578 
580  bool m_tagsHasBeenSet;
581 
582  AuthMode m_portalAuthMode;
583  bool m_portalAuthModeHasBeenSet;
584  };
585 
586 } // namespace Model
587 } // namespace IoTSiteWise
588 } // namespace Aws
Aws::IoTSiteWise::Model::CreatePortalRequest::AddTags
CreatePortalRequest & AddTags(Aws::String &&key, const char *value)
Definition: CreatePortalRequest.h:451
AuthMode.h
Aws::IoTSiteWise::Model::CreatePortalRequest::PortalAuthModeHasBeenSet
bool PortalAuthModeHasBeenSet() const
Definition: CreatePortalRequest.h:493
Aws::IoTSiteWise::Model::CreatePortalRequest::AddTags
CreatePortalRequest & AddTags(Aws::String &&key, Aws::String &&value)
Definition: CreatePortalRequest.h:433
Aws::IoTSiteWise::Model::CreatePortalRequest::WithTags
CreatePortalRequest & WithTags(Aws::Map< Aws::String, Aws::String > &&value)
Definition: CreatePortalRequest.h:397
Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalName
CreatePortalRequest & WithPortalName(const Aws::String &value)
Definition: CreatePortalRequest.h:67
Aws::IoTSiteWise::Model::CreatePortalRequest::SetRoleArn
void SetRoleArn(Aws::String &&value)
Definition: CreatePortalRequest.h:298
Aws::IoTSiteWise::Model::CreatePortalRequest::WithClientToken
CreatePortalRequest & WithClientToken(Aws::String &&value)
Definition: CreatePortalRequest.h:209
IoTSiteWise_EXPORTS.h
Aws::IoTSiteWise::Model::CreatePortalRequest::AddTags
CreatePortalRequest & AddTags(const Aws::String &key, Aws::String &&value)
Definition: CreatePortalRequest.h:424
Aws::IoTSiteWise::Model::CreatePortalRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::IoTSiteWise::Model::CreatePortalRequest::SetRoleArn
void SetRoleArn(const Aws::String &value)
Definition: CreatePortalRequest.h:287
Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalName
CreatePortalRequest & WithPortalName(const char *value)
Definition: CreatePortalRequest.h:77
AWS_IOTSITEWISE_API
#define AWS_IOTSITEWISE_API
Definition: IoTSiteWise_EXPORTS.h:28
Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalAuthMode
CreatePortalRequest & WithPortalAuthMode(const AuthMode &value)
Definition: CreatePortalRequest.h:541
Aws::IoTSiteWise::Model::CreatePortalRequest::RoleArnHasBeenSet
bool RoleArnHasBeenSet() const
Definition: CreatePortalRequest.h:276
Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalAuthMode
CreatePortalRequest & WithPortalAuthMode(AuthMode &&value)
Definition: CreatePortalRequest.h:557
Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalContactEmail
CreatePortalRequest & WithPortalContactEmail(Aws::String &&value)
Definition: CreatePortalRequest.h:154
Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalName
void SetPortalName(const Aws::String &value)
Definition: CreatePortalRequest.h:52
Aws::IoTSiteWise::Model::CreatePortalRequest::AddTags
CreatePortalRequest & AddTags(const char *key, Aws::String &&value)
Definition: CreatePortalRequest.h:442
Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalDescription
CreatePortalRequest & WithPortalDescription(const char *value)
Definition: CreatePortalRequest.h:118
Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalAuthMode
void SetPortalAuthMode(const AuthMode &value)
Definition: CreatePortalRequest.h:509
Aws::IoTSiteWise::Model::CreatePortalRequest::AddTags
CreatePortalRequest & AddTags(Aws::String &&key, const Aws::String &value)
Definition: CreatePortalRequest.h:415
Aws::IoTSiteWise::Model::CreatePortalRequest::GetPortalContactEmail
const Aws::String & GetPortalContactEmail() const
Definition: CreatePortalRequest.h:124
Aws::IoTSiteWise::Model::CreatePortalRequest::WithRoleArn
CreatePortalRequest & WithRoleArn(Aws::String &&value)
Definition: CreatePortalRequest.h:331
Aws::IoTSiteWise::Model::CreatePortalRequest::ClientTokenHasBeenSet
bool ClientTokenHasBeenSet() const
Definition: CreatePortalRequest.h:174
Aws::IoTSiteWise::Model::CreatePortalRequest::GetPortalDescription
const Aws::String & GetPortalDescription() const
Definition: CreatePortalRequest.h:83
Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalName
CreatePortalRequest & WithPortalName(Aws::String &&value)
Definition: CreatePortalRequest.h:72
Aws::IoTSiteWise::Model::CreatePortalRequest::SetTags
void SetTags(Aws::Map< Aws::String, Aws::String > &&value)
Definition: CreatePortalRequest.h:379
Aws::IoTSiteWise::Model::CreatePortalRequest::WithTags
CreatePortalRequest & WithTags(const Aws::Map< Aws::String, Aws::String > &value)
Definition: CreatePortalRequest.h:388
Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalContactEmail
CreatePortalRequest & WithPortalContactEmail(const Aws::String &value)
Definition: CreatePortalRequest.h:149
Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalContactEmail
void SetPortalContactEmail(Aws::String &&value)
Definition: CreatePortalRequest.h:139
Aws::IoTSiteWise::Model::AuthMode
AuthMode
Definition: AuthMode.h:17
Aws::IoTSiteWise::Model::CreatePortalRequest::WithRoleArn
CreatePortalRequest & WithRoleArn(const Aws::String &value)
Definition: CreatePortalRequest.h:320
ImageFile.h
Aws::IoTSiteWise::Model::CreatePortalRequest::SetTags
void SetTags(const Aws::Map< Aws::String, Aws::String > &value)
Definition: CreatePortalRequest.h:370
Aws::IoTSiteWise::Model::CreatePortalRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: CreatePortalRequest.h:34
Aws::IoTSiteWise::Model::CreatePortalRequest::PortalNameHasBeenSet
bool PortalNameHasBeenSet() const
Definition: CreatePortalRequest.h:47
Aws::IoTSiteWise::Model::CreatePortalRequest::SetClientToken
void SetClientToken(const char *value)
Definition: CreatePortalRequest.h:195
Aws::IoTSiteWise::Model::CreatePortalRequest
Definition: CreatePortalRequest.h:26
Aws::IoTSiteWise::Model::CreatePortalRequest::SetClientToken
void SetClientToken(Aws::String &&value)
Definition: CreatePortalRequest.h:188
Aws::IoTSiteWise::Model::CreatePortalRequest::WithClientToken
CreatePortalRequest & WithClientToken(const Aws::String &value)
Definition: CreatePortalRequest.h:202
Aws::IoTSiteWise::Model::CreatePortalRequest::CreatePortalRequest
CreatePortalRequest()
Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalDescription
void SetPortalDescription(Aws::String &&value)
Definition: CreatePortalRequest.h:98
Aws::IoTSiteWise::Model::CreatePortalRequest::SetClientToken
void SetClientToken(const Aws::String &value)
Definition: CreatePortalRequest.h:181
AWSString.h
Aws::IoTSiteWise::Model::CreatePortalRequest::PortalLogoImageFileHasBeenSet
bool PortalLogoImageFileHasBeenSet() const
Definition: CreatePortalRequest.h:229
Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalLogoImageFile
void SetPortalLogoImageFile(const ImageFile &value)
Definition: CreatePortalRequest.h:235
Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalName
void SetPortalName(Aws::String &&value)
Definition: CreatePortalRequest.h:57
Aws::IoTSiteWise::Model::CreatePortalRequest::WithRoleArn
CreatePortalRequest & WithRoleArn(const char *value)
Definition: CreatePortalRequest.h:342
Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalDescription
CreatePortalRequest & WithPortalDescription(Aws::String &&value)
Definition: CreatePortalRequest.h:113
Aws::IoTSiteWise::Model::CreatePortalRequest::GetPortalAuthMode
const AuthMode & GetPortalAuthMode() const
Definition: CreatePortalRequest.h:477
Aws::IoTSiteWise::Model::CreatePortalRequest::AddTags
CreatePortalRequest & AddTags(const Aws::String &key, const Aws::String &value)
Definition: CreatePortalRequest.h:406
Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalContactEmail
CreatePortalRequest & WithPortalContactEmail(const char *value)
Definition: CreatePortalRequest.h:159
Aws::IoTSiteWise::Model::CreatePortalRequest::TagsHasBeenSet
bool TagsHasBeenSet() const
Definition: CreatePortalRequest.h:361
Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalLogoImageFile
void SetPortalLogoImageFile(ImageFile &&value)
Definition: CreatePortalRequest.h:241
Aws::IoTSiteWise::Model::CreatePortalRequest::GetPortalName
const Aws::String & GetPortalName() const
Definition: CreatePortalRequest.h:42
Aws::IoTSiteWise::Model::CreatePortalRequest::AddTags
CreatePortalRequest & AddTags(const char *key, const char *value)
Definition: CreatePortalRequest.h:460
Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalDescription
void SetPortalDescription(const Aws::String &value)
Definition: CreatePortalRequest.h:93
Aws::IoTSiteWise::Model::CreatePortalRequest::GetPortalLogoImageFile
const ImageFile & GetPortalLogoImageFile() const
Definition: CreatePortalRequest.h:223
Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalName
void SetPortalName(const char *value)
Definition: CreatePortalRequest.h:62
Aws
Definition: AccessManagementClient.h:15
IoTSiteWiseRequest.h
Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalContactEmail
void SetPortalContactEmail(const char *value)
Definition: CreatePortalRequest.h:144
Aws::IoTSiteWise::Model::CreatePortalRequest::GetRoleArn
const Aws::String & GetRoleArn() const
Definition: CreatePortalRequest.h:265
Aws::IoTSiteWise::Model::CreatePortalRequest::WithClientToken
CreatePortalRequest & WithClientToken(const char *value)
Definition: CreatePortalRequest.h:216
Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalContactEmail
void SetPortalContactEmail(const Aws::String &value)
Definition: CreatePortalRequest.h:134
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalDescription
CreatePortalRequest & WithPortalDescription(const Aws::String &value)
Definition: CreatePortalRequest.h:108
Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalLogoImageFile
CreatePortalRequest & WithPortalLogoImageFile(const ImageFile &value)
Definition: CreatePortalRequest.h:247
Aws::IoTSiteWise::Model::CreatePortalRequest::PortalDescriptionHasBeenSet
bool PortalDescriptionHasBeenSet() const
Definition: CreatePortalRequest.h:88
Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalDescription
void SetPortalDescription(const char *value)
Definition: CreatePortalRequest.h:103
Aws::IoTSiteWise::Model::ImageFile
Definition: ImageFile.h:33
Aws::IoTSiteWise::IoTSiteWiseRequest
Definition: IoTSiteWiseRequest.h:17
UUID.h
Aws::IoTSiteWise::Model::CreatePortalRequest::SetRoleArn
void SetRoleArn(const char *value)
Definition: CreatePortalRequest.h:309
Aws::IoTSiteWise::Model::CreatePortalRequest::SetPortalAuthMode
void SetPortalAuthMode(AuthMode &&value)
Definition: CreatePortalRequest.h:525
AWSMap.h
Aws::IoTSiteWise::Model::CreatePortalRequest::WithPortalLogoImageFile
CreatePortalRequest & WithPortalLogoImageFile(ImageFile &&value)
Definition: CreatePortalRequest.h:253
Aws::IoTSiteWise::Model::CreatePortalRequest::PortalContactEmailHasBeenSet
bool PortalContactEmailHasBeenSet() const
Definition: CreatePortalRequest.h:129
Aws::IoTSiteWise::Model::CreatePortalRequest::GetTags
const Aws::Map< Aws::String, Aws::String > & GetTags() const
Definition: CreatePortalRequest.h:352
Aws::Map
std::map< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > > Map
Definition: AWSMap.h:19
Aws::IoTSiteWise::Model::CreatePortalRequest::GetClientToken
const Aws::String & GetClientToken() const
Definition: CreatePortalRequest.h:167