AWS SDK for C++

AWS SDK for C++ Version 1.11.608

Loading...
Searching...
No Matches
DescribePortalResult.h
1
6#pragma once
7#include <aws/iotsitewise/IoTSiteWise_EXPORTS.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/iotsitewise/model/PortalStatus.h>
10#include <aws/core/utils/DateTime.h>
11#include <aws/iotsitewise/model/ImageLocation.h>
12#include <aws/iotsitewise/model/AuthMode.h>
13#include <aws/iotsitewise/model/Alarms.h>
14#include <aws/iotsitewise/model/PortalType.h>
15#include <aws/core/utils/memory/stl/AWSMap.h>
16#include <aws/iotsitewise/model/PortalTypeEntry.h>
17#include <utility>
18
19namespace Aws
20{
21template<typename RESULT_TYPE>
22class AmazonWebServiceResult;
23
24namespace Utils
25{
26namespace Json
27{
28 class JsonValue;
29} // namespace Json
30} // namespace Utils
31namespace IoTSiteWise
32{
33namespace Model
34{
36 {
37 public:
38 AWS_IOTSITEWISE_API DescribePortalResult() = default;
41
42
44
47 inline const Aws::String& GetPortalId() const { return m_portalId; }
48 template<typename PortalIdT = Aws::String>
49 void SetPortalId(PortalIdT&& value) { m_portalIdHasBeenSet = true; m_portalId = std::forward<PortalIdT>(value); }
50 template<typename PortalIdT = Aws::String>
51 DescribePortalResult& WithPortalId(PortalIdT&& value) { SetPortalId(std::forward<PortalIdT>(value)); return *this;}
53
55
62 inline const Aws::String& GetPortalArn() const { return m_portalArn; }
63 template<typename PortalArnT = Aws::String>
64 void SetPortalArn(PortalArnT&& value) { m_portalArnHasBeenSet = true; m_portalArn = std::forward<PortalArnT>(value); }
65 template<typename PortalArnT = Aws::String>
66 DescribePortalResult& WithPortalArn(PortalArnT&& value) { SetPortalArn(std::forward<PortalArnT>(value)); return *this;}
68
70
73 inline const Aws::String& GetPortalName() const { return m_portalName; }
74 template<typename PortalNameT = Aws::String>
75 void SetPortalName(PortalNameT&& value) { m_portalNameHasBeenSet = true; m_portalName = std::forward<PortalNameT>(value); }
76 template<typename PortalNameT = Aws::String>
77 DescribePortalResult& WithPortalName(PortalNameT&& value) { SetPortalName(std::forward<PortalNameT>(value)); return *this;}
79
81
84 inline const Aws::String& GetPortalDescription() const { return m_portalDescription; }
85 template<typename PortalDescriptionT = Aws::String>
86 void SetPortalDescription(PortalDescriptionT&& value) { m_portalDescriptionHasBeenSet = true; m_portalDescription = std::forward<PortalDescriptionT>(value); }
87 template<typename PortalDescriptionT = Aws::String>
88 DescribePortalResult& WithPortalDescription(PortalDescriptionT&& value) { SetPortalDescription(std::forward<PortalDescriptionT>(value)); return *this;}
90
92
98 inline const Aws::String& GetPortalClientId() const { return m_portalClientId; }
99 template<typename PortalClientIdT = Aws::String>
100 void SetPortalClientId(PortalClientIdT&& value) { m_portalClientIdHasBeenSet = true; m_portalClientId = std::forward<PortalClientIdT>(value); }
101 template<typename PortalClientIdT = Aws::String>
102 DescribePortalResult& WithPortalClientId(PortalClientIdT&& value) { SetPortalClientId(std::forward<PortalClientIdT>(value)); return *this;}
104
106
112 inline const Aws::String& GetPortalStartUrl() const { return m_portalStartUrl; }
113 template<typename PortalStartUrlT = Aws::String>
114 void SetPortalStartUrl(PortalStartUrlT&& value) { m_portalStartUrlHasBeenSet = true; m_portalStartUrl = std::forward<PortalStartUrlT>(value); }
115 template<typename PortalStartUrlT = Aws::String>
116 DescribePortalResult& WithPortalStartUrl(PortalStartUrlT&& value) { SetPortalStartUrl(std::forward<PortalStartUrlT>(value)); return *this;}
118
120
123 inline const Aws::String& GetPortalContactEmail() const { return m_portalContactEmail; }
124 template<typename PortalContactEmailT = Aws::String>
125 void SetPortalContactEmail(PortalContactEmailT&& value) { m_portalContactEmailHasBeenSet = true; m_portalContactEmail = std::forward<PortalContactEmailT>(value); }
126 template<typename PortalContactEmailT = Aws::String>
127 DescribePortalResult& WithPortalContactEmail(PortalContactEmailT&& value) { SetPortalContactEmail(std::forward<PortalContactEmailT>(value)); return *this;}
129
131
135 inline const PortalStatus& GetPortalStatus() const { return m_portalStatus; }
136 template<typename PortalStatusT = PortalStatus>
137 void SetPortalStatus(PortalStatusT&& value) { m_portalStatusHasBeenSet = true; m_portalStatus = std::forward<PortalStatusT>(value); }
138 template<typename PortalStatusT = PortalStatus>
139 DescribePortalResult& WithPortalStatus(PortalStatusT&& value) { SetPortalStatus(std::forward<PortalStatusT>(value)); return *this;}
141
143
146 inline const Aws::Utils::DateTime& GetPortalCreationDate() const { return m_portalCreationDate; }
147 template<typename PortalCreationDateT = Aws::Utils::DateTime>
148 void SetPortalCreationDate(PortalCreationDateT&& value) { m_portalCreationDateHasBeenSet = true; m_portalCreationDate = std::forward<PortalCreationDateT>(value); }
149 template<typename PortalCreationDateT = Aws::Utils::DateTime>
150 DescribePortalResult& WithPortalCreationDate(PortalCreationDateT&& value) { SetPortalCreationDate(std::forward<PortalCreationDateT>(value)); return *this;}
152
154
157 inline const Aws::Utils::DateTime& GetPortalLastUpdateDate() const { return m_portalLastUpdateDate; }
158 template<typename PortalLastUpdateDateT = Aws::Utils::DateTime>
159 void SetPortalLastUpdateDate(PortalLastUpdateDateT&& value) { m_portalLastUpdateDateHasBeenSet = true; m_portalLastUpdateDate = std::forward<PortalLastUpdateDateT>(value); }
160 template<typename PortalLastUpdateDateT = Aws::Utils::DateTime>
161 DescribePortalResult& WithPortalLastUpdateDate(PortalLastUpdateDateT&& value) { SetPortalLastUpdateDate(std::forward<PortalLastUpdateDateT>(value)); return *this;}
163
165
168 inline const ImageLocation& GetPortalLogoImageLocation() const { return m_portalLogoImageLocation; }
169 template<typename PortalLogoImageLocationT = ImageLocation>
170 void SetPortalLogoImageLocation(PortalLogoImageLocationT&& value) { m_portalLogoImageLocationHasBeenSet = true; m_portalLogoImageLocation = std::forward<PortalLogoImageLocationT>(value); }
171 template<typename PortalLogoImageLocationT = ImageLocation>
172 DescribePortalResult& WithPortalLogoImageLocation(PortalLogoImageLocationT&& value) { SetPortalLogoImageLocation(std::forward<PortalLogoImageLocationT>(value)); return *this;}
174
176
185 inline const Aws::String& GetRoleArn() const { return m_roleArn; }
186 template<typename RoleArnT = Aws::String>
187 void SetRoleArn(RoleArnT&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::forward<RoleArnT>(value); }
188 template<typename RoleArnT = Aws::String>
189 DescribePortalResult& WithRoleArn(RoleArnT&& value) { SetRoleArn(std::forward<RoleArnT>(value)); return *this;}
191
193
196 inline AuthMode GetPortalAuthMode() const { return m_portalAuthMode; }
197 inline void SetPortalAuthMode(AuthMode value) { m_portalAuthModeHasBeenSet = true; m_portalAuthMode = value; }
200
202
205 inline const Aws::String& GetNotificationSenderEmail() const { return m_notificationSenderEmail; }
206 template<typename NotificationSenderEmailT = Aws::String>
207 void SetNotificationSenderEmail(NotificationSenderEmailT&& value) { m_notificationSenderEmailHasBeenSet = true; m_notificationSenderEmail = std::forward<NotificationSenderEmailT>(value); }
208 template<typename NotificationSenderEmailT = Aws::String>
209 DescribePortalResult& WithNotificationSenderEmail(NotificationSenderEmailT&& value) { SetNotificationSenderEmail(std::forward<NotificationSenderEmailT>(value)); return *this;}
211
213
217 inline const Alarms& GetAlarms() const { return m_alarms; }
218 template<typename AlarmsT = Alarms>
219 void SetAlarms(AlarmsT&& value) { m_alarmsHasBeenSet = true; m_alarms = std::forward<AlarmsT>(value); }
220 template<typename AlarmsT = Alarms>
221 DescribePortalResult& WithAlarms(AlarmsT&& value) { SetAlarms(std::forward<AlarmsT>(value)); return *this;}
223
225
230 inline PortalType GetPortalType() const { return m_portalType; }
231 inline void SetPortalType(PortalType value) { m_portalTypeHasBeenSet = true; m_portalType = value; }
232 inline DescribePortalResult& WithPortalType(PortalType value) { SetPortalType(value); return *this;}
234
236
241 inline const Aws::Map<Aws::String, PortalTypeEntry>& GetPortalTypeConfiguration() const { return m_portalTypeConfiguration; }
242 template<typename PortalTypeConfigurationT = Aws::Map<Aws::String, PortalTypeEntry>>
243 void SetPortalTypeConfiguration(PortalTypeConfigurationT&& value) { m_portalTypeConfigurationHasBeenSet = true; m_portalTypeConfiguration = std::forward<PortalTypeConfigurationT>(value); }
244 template<typename PortalTypeConfigurationT = Aws::Map<Aws::String, PortalTypeEntry>>
245 DescribePortalResult& WithPortalTypeConfiguration(PortalTypeConfigurationT&& value) { SetPortalTypeConfiguration(std::forward<PortalTypeConfigurationT>(value)); return *this;}
246 template<typename PortalTypeConfigurationKeyT = Aws::String, typename PortalTypeConfigurationValueT = PortalTypeEntry>
247 DescribePortalResult& AddPortalTypeConfiguration(PortalTypeConfigurationKeyT&& key, PortalTypeConfigurationValueT&& value) {
248 m_portalTypeConfigurationHasBeenSet = true; m_portalTypeConfiguration.emplace(std::forward<PortalTypeConfigurationKeyT>(key), std::forward<PortalTypeConfigurationValueT>(value)); return *this;
249 }
251
253
254 inline const Aws::String& GetRequestId() const { return m_requestId; }
255 template<typename RequestIdT = Aws::String>
256 void SetRequestId(RequestIdT&& value) { m_requestIdHasBeenSet = true; m_requestId = std::forward<RequestIdT>(value); }
257 template<typename RequestIdT = Aws::String>
258 DescribePortalResult& WithRequestId(RequestIdT&& value) { SetRequestId(std::forward<RequestIdT>(value)); return *this;}
260 private:
261
262 Aws::String m_portalId;
263 bool m_portalIdHasBeenSet = false;
264
265 Aws::String m_portalArn;
266 bool m_portalArnHasBeenSet = false;
267
268 Aws::String m_portalName;
269 bool m_portalNameHasBeenSet = false;
270
271 Aws::String m_portalDescription;
272 bool m_portalDescriptionHasBeenSet = false;
273
274 Aws::String m_portalClientId;
275 bool m_portalClientIdHasBeenSet = false;
276
277 Aws::String m_portalStartUrl;
278 bool m_portalStartUrlHasBeenSet = false;
279
280 Aws::String m_portalContactEmail;
281 bool m_portalContactEmailHasBeenSet = false;
282
283 PortalStatus m_portalStatus;
284 bool m_portalStatusHasBeenSet = false;
285
286 Aws::Utils::DateTime m_portalCreationDate{};
287 bool m_portalCreationDateHasBeenSet = false;
288
289 Aws::Utils::DateTime m_portalLastUpdateDate{};
290 bool m_portalLastUpdateDateHasBeenSet = false;
291
292 ImageLocation m_portalLogoImageLocation;
293 bool m_portalLogoImageLocationHasBeenSet = false;
294
295 Aws::String m_roleArn;
296 bool m_roleArnHasBeenSet = false;
297
298 AuthMode m_portalAuthMode{AuthMode::NOT_SET};
299 bool m_portalAuthModeHasBeenSet = false;
300
301 Aws::String m_notificationSenderEmail;
302 bool m_notificationSenderEmailHasBeenSet = false;
303
304 Alarms m_alarms;
305 bool m_alarmsHasBeenSet = false;
306
307 PortalType m_portalType{PortalType::NOT_SET};
308 bool m_portalTypeHasBeenSet = false;
309
310 Aws::Map<Aws::String, PortalTypeEntry> m_portalTypeConfiguration;
311 bool m_portalTypeConfigurationHasBeenSet = false;
312
313 Aws::String m_requestId;
314 bool m_requestIdHasBeenSet = false;
315 };
316
317} // namespace Model
318} // namespace IoTSiteWise
319} // namespace Aws
DescribePortalResult & WithPortalLogoImageLocation(PortalLogoImageLocationT &&value)
const ImageLocation & GetPortalLogoImageLocation() const
DescribePortalResult & WithPortalAuthMode(AuthMode value)
DescribePortalResult & WithPortalLastUpdateDate(PortalLastUpdateDateT &&value)
AWS_IOTSITEWISE_API DescribePortalResult()=default
DescribePortalResult & WithPortalName(PortalNameT &&value)
DescribePortalResult & WithRoleArn(RoleArnT &&value)
const Aws::Utils::DateTime & GetPortalLastUpdateDate() const
void SetPortalLogoImageLocation(PortalLogoImageLocationT &&value)
void SetPortalContactEmail(PortalContactEmailT &&value)
const Aws::Map< Aws::String, PortalTypeEntry > & GetPortalTypeConfiguration() const
DescribePortalResult & WithPortalContactEmail(PortalContactEmailT &&value)
DescribePortalResult & WithPortalType(PortalType value)
const Aws::Utils::DateTime & GetPortalCreationDate() const
void SetPortalCreationDate(PortalCreationDateT &&value)
DescribePortalResult & WithAlarms(AlarmsT &&value)
void SetNotificationSenderEmail(NotificationSenderEmailT &&value)
DescribePortalResult & WithPortalStartUrl(PortalStartUrlT &&value)
void SetPortalLastUpdateDate(PortalLastUpdateDateT &&value)
void SetPortalTypeConfiguration(PortalTypeConfigurationT &&value)
DescribePortalResult & WithPortalArn(PortalArnT &&value)
AWS_IOTSITEWISE_API DescribePortalResult & operator=(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
DescribePortalResult & AddPortalTypeConfiguration(PortalTypeConfigurationKeyT &&key, PortalTypeConfigurationValueT &&value)
void SetPortalDescription(PortalDescriptionT &&value)
AWS_IOTSITEWISE_API DescribePortalResult(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
DescribePortalResult & WithPortalStatus(PortalStatusT &&value)
DescribePortalResult & WithPortalId(PortalIdT &&value)
DescribePortalResult & WithNotificationSenderEmail(NotificationSenderEmailT &&value)
DescribePortalResult & WithRequestId(RequestIdT &&value)
DescribePortalResult & WithPortalCreationDate(PortalCreationDateT &&value)
DescribePortalResult & WithPortalClientId(PortalClientIdT &&value)
DescribePortalResult & WithPortalTypeConfiguration(PortalTypeConfigurationT &&value)
DescribePortalResult & WithPortalDescription(PortalDescriptionT &&value)
std::map< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > > Map
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Aws::Utils::Json::JsonValue JsonValue