/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include namespace Aws { template class AmazonWebServiceResult; namespace Utils { namespace Json { class JsonValue; } // namespace Json } // namespace Utils namespace IoTSiteWise { namespace Model { class DescribePortalResult { public: AWS_IOTSITEWISE_API DescribePortalResult(); AWS_IOTSITEWISE_API DescribePortalResult(const Aws::AmazonWebServiceResult& result); AWS_IOTSITEWISE_API DescribePortalResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

The ID of the portal.

*/ inline const Aws::String& GetPortalId() const{ return m_portalId; } /** *

The ID of the portal.

*/ inline void SetPortalId(const Aws::String& value) { m_portalId = value; } /** *

The ID of the portal.

*/ inline void SetPortalId(Aws::String&& value) { m_portalId = std::move(value); } /** *

The ID of the portal.

*/ inline void SetPortalId(const char* value) { m_portalId.assign(value); } /** *

The ID of the portal.

*/ inline DescribePortalResult& WithPortalId(const Aws::String& value) { SetPortalId(value); return *this;} /** *

The ID of the portal.

*/ inline DescribePortalResult& WithPortalId(Aws::String&& value) { SetPortalId(std::move(value)); return *this;} /** *

The ID of the portal.

*/ inline DescribePortalResult& WithPortalId(const char* value) { SetPortalId(value); return *this;} /** *

The ARN * of the portal, which has the following format.

* arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId} *

*/ inline const Aws::String& GetPortalArn() const{ return m_portalArn; } /** *

The ARN * of the portal, which has the following format.

* arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId} *

*/ inline void SetPortalArn(const Aws::String& value) { m_portalArn = value; } /** *

The ARN * of the portal, which has the following format.

* arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId} *

*/ inline void SetPortalArn(Aws::String&& value) { m_portalArn = std::move(value); } /** *

The ARN * of the portal, which has the following format.

* arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId} *

*/ inline void SetPortalArn(const char* value) { m_portalArn.assign(value); } /** *

The ARN * of the portal, which has the following format.

* arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId} *

*/ inline DescribePortalResult& WithPortalArn(const Aws::String& value) { SetPortalArn(value); return *this;} /** *

The ARN * of the portal, which has the following format.

* arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId} *

*/ inline DescribePortalResult& WithPortalArn(Aws::String&& value) { SetPortalArn(std::move(value)); return *this;} /** *

The ARN * of the portal, which has the following format.

* arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId} *

*/ inline DescribePortalResult& WithPortalArn(const char* value) { SetPortalArn(value); return *this;} /** *

The name of the portal.

*/ inline const Aws::String& GetPortalName() const{ return m_portalName; } /** *

The name of the portal.

*/ inline void SetPortalName(const Aws::String& value) { m_portalName = value; } /** *

The name of the portal.

*/ inline void SetPortalName(Aws::String&& value) { m_portalName = std::move(value); } /** *

The name of the portal.

*/ inline void SetPortalName(const char* value) { m_portalName.assign(value); } /** *

The name of the portal.

*/ inline DescribePortalResult& WithPortalName(const Aws::String& value) { SetPortalName(value); return *this;} /** *

The name of the portal.

*/ inline DescribePortalResult& WithPortalName(Aws::String&& value) { SetPortalName(std::move(value)); return *this;} /** *

The name of the portal.

*/ inline DescribePortalResult& WithPortalName(const char* value) { SetPortalName(value); return *this;} /** *

The portal's description.

*/ inline const Aws::String& GetPortalDescription() const{ return m_portalDescription; } /** *

The portal's description.

*/ inline void SetPortalDescription(const Aws::String& value) { m_portalDescription = value; } /** *

The portal's description.

*/ inline void SetPortalDescription(Aws::String&& value) { m_portalDescription = std::move(value); } /** *

The portal's description.

*/ inline void SetPortalDescription(const char* value) { m_portalDescription.assign(value); } /** *

The portal's description.

*/ inline DescribePortalResult& WithPortalDescription(const Aws::String& value) { SetPortalDescription(value); return *this;} /** *

The portal's description.

*/ inline DescribePortalResult& WithPortalDescription(Aws::String&& value) { SetPortalDescription(std::move(value)); return *this;} /** *

The portal's description.

*/ inline DescribePortalResult& WithPortalDescription(const char* value) { SetPortalDescription(value); return *this;} /** *

The IAM Identity Center application generated client ID (used with IAM * Identity Center APIs). IoT SiteWise includes portalClientId for * only portals that use IAM Identity Center to authenticate users.

*/ inline const Aws::String& GetPortalClientId() const{ return m_portalClientId; } /** *

The IAM Identity Center application generated client ID (used with IAM * Identity Center APIs). IoT SiteWise includes portalClientId for * only portals that use IAM Identity Center to authenticate users.

*/ inline void SetPortalClientId(const Aws::String& value) { m_portalClientId = value; } /** *

The IAM Identity Center application generated client ID (used with IAM * Identity Center APIs). IoT SiteWise includes portalClientId for * only portals that use IAM Identity Center to authenticate users.

*/ inline void SetPortalClientId(Aws::String&& value) { m_portalClientId = std::move(value); } /** *

The IAM Identity Center application generated client ID (used with IAM * Identity Center APIs). IoT SiteWise includes portalClientId for * only portals that use IAM Identity Center to authenticate users.

*/ inline void SetPortalClientId(const char* value) { m_portalClientId.assign(value); } /** *

The IAM Identity Center application generated client ID (used with IAM * Identity Center APIs). IoT SiteWise includes portalClientId for * only portals that use IAM Identity Center to authenticate users.

*/ inline DescribePortalResult& WithPortalClientId(const Aws::String& value) { SetPortalClientId(value); return *this;} /** *

The IAM Identity Center application generated client ID (used with IAM * Identity Center APIs). IoT SiteWise includes portalClientId for * only portals that use IAM Identity Center to authenticate users.

*/ inline DescribePortalResult& WithPortalClientId(Aws::String&& value) { SetPortalClientId(std::move(value)); return *this;} /** *

The IAM Identity Center application generated client ID (used with IAM * Identity Center APIs). IoT SiteWise includes portalClientId for * only portals that use IAM Identity Center to authenticate users.

*/ inline DescribePortalResult& WithPortalClientId(const char* value) { SetPortalClientId(value); return *this;} /** *

The URL for the IoT SiteWise Monitor portal. You can use this URL to access * portals that use IAM Identity Center for authentication. For portals that use * IAM for authentication, you must use the IoT SiteWise console to get a URL that * you can use to access the portal.

*/ inline const Aws::String& GetPortalStartUrl() const{ return m_portalStartUrl; } /** *

The URL for the IoT SiteWise Monitor portal. You can use this URL to access * portals that use IAM Identity Center for authentication. For portals that use * IAM for authentication, you must use the IoT SiteWise console to get a URL that * you can use to access the portal.

*/ inline void SetPortalStartUrl(const Aws::String& value) { m_portalStartUrl = value; } /** *

The URL for the IoT SiteWise Monitor portal. You can use this URL to access * portals that use IAM Identity Center for authentication. For portals that use * IAM for authentication, you must use the IoT SiteWise console to get a URL that * you can use to access the portal.

*/ inline void SetPortalStartUrl(Aws::String&& value) { m_portalStartUrl = std::move(value); } /** *

The URL for the IoT SiteWise Monitor portal. You can use this URL to access * portals that use IAM Identity Center for authentication. For portals that use * IAM for authentication, you must use the IoT SiteWise console to get a URL that * you can use to access the portal.

*/ inline void SetPortalStartUrl(const char* value) { m_portalStartUrl.assign(value); } /** *

The URL for the IoT SiteWise Monitor portal. You can use this URL to access * portals that use IAM Identity Center for authentication. For portals that use * IAM for authentication, you must use the IoT SiteWise console to get a URL that * you can use to access the portal.

*/ inline DescribePortalResult& WithPortalStartUrl(const Aws::String& value) { SetPortalStartUrl(value); return *this;} /** *

The URL for the IoT SiteWise Monitor portal. You can use this URL to access * portals that use IAM Identity Center for authentication. For portals that use * IAM for authentication, you must use the IoT SiteWise console to get a URL that * you can use to access the portal.

*/ inline DescribePortalResult& WithPortalStartUrl(Aws::String&& value) { SetPortalStartUrl(std::move(value)); return *this;} /** *

The URL for the IoT SiteWise Monitor portal. You can use this URL to access * portals that use IAM Identity Center for authentication. For portals that use * IAM for authentication, you must use the IoT SiteWise console to get a URL that * you can use to access the portal.

*/ inline DescribePortalResult& WithPortalStartUrl(const char* value) { SetPortalStartUrl(value); return *this;} /** *

The Amazon Web Services administrator's contact email address.

*/ inline const Aws::String& GetPortalContactEmail() const{ return m_portalContactEmail; } /** *

The Amazon Web Services administrator's contact email address.

*/ inline void SetPortalContactEmail(const Aws::String& value) { m_portalContactEmail = value; } /** *

The Amazon Web Services administrator's contact email address.

*/ inline void SetPortalContactEmail(Aws::String&& value) { m_portalContactEmail = std::move(value); } /** *

The Amazon Web Services administrator's contact email address.

*/ inline void SetPortalContactEmail(const char* value) { m_portalContactEmail.assign(value); } /** *

The Amazon Web Services administrator's contact email address.

*/ inline DescribePortalResult& WithPortalContactEmail(const Aws::String& value) { SetPortalContactEmail(value); return *this;} /** *

The Amazon Web Services administrator's contact email address.

*/ inline DescribePortalResult& WithPortalContactEmail(Aws::String&& value) { SetPortalContactEmail(std::move(value)); return *this;} /** *

The Amazon Web Services administrator's contact email address.

*/ inline DescribePortalResult& WithPortalContactEmail(const char* value) { SetPortalContactEmail(value); return *this;} /** *

The current status of the portal, which contains a state and any error * message.

*/ inline const PortalStatus& GetPortalStatus() const{ return m_portalStatus; } /** *

The current status of the portal, which contains a state and any error * message.

*/ inline void SetPortalStatus(const PortalStatus& value) { m_portalStatus = value; } /** *

The current status of the portal, which contains a state and any error * message.

*/ inline void SetPortalStatus(PortalStatus&& value) { m_portalStatus = std::move(value); } /** *

The current status of the portal, which contains a state and any error * message.

*/ inline DescribePortalResult& WithPortalStatus(const PortalStatus& value) { SetPortalStatus(value); return *this;} /** *

The current status of the portal, which contains a state and any error * message.

*/ inline DescribePortalResult& WithPortalStatus(PortalStatus&& value) { SetPortalStatus(std::move(value)); return *this;} /** *

The date the portal was created, in Unix epoch time.

*/ inline const Aws::Utils::DateTime& GetPortalCreationDate() const{ return m_portalCreationDate; } /** *

The date the portal was created, in Unix epoch time.

*/ inline void SetPortalCreationDate(const Aws::Utils::DateTime& value) { m_portalCreationDate = value; } /** *

The date the portal was created, in Unix epoch time.

*/ inline void SetPortalCreationDate(Aws::Utils::DateTime&& value) { m_portalCreationDate = std::move(value); } /** *

The date the portal was created, in Unix epoch time.

*/ inline DescribePortalResult& WithPortalCreationDate(const Aws::Utils::DateTime& value) { SetPortalCreationDate(value); return *this;} /** *

The date the portal was created, in Unix epoch time.

*/ inline DescribePortalResult& WithPortalCreationDate(Aws::Utils::DateTime&& value) { SetPortalCreationDate(std::move(value)); return *this;} /** *

The date the portal was last updated, in Unix epoch time.

*/ inline const Aws::Utils::DateTime& GetPortalLastUpdateDate() const{ return m_portalLastUpdateDate; } /** *

The date the portal was last updated, in Unix epoch time.

*/ inline void SetPortalLastUpdateDate(const Aws::Utils::DateTime& value) { m_portalLastUpdateDate = value; } /** *

The date the portal was last updated, in Unix epoch time.

*/ inline void SetPortalLastUpdateDate(Aws::Utils::DateTime&& value) { m_portalLastUpdateDate = std::move(value); } /** *

The date the portal was last updated, in Unix epoch time.

*/ inline DescribePortalResult& WithPortalLastUpdateDate(const Aws::Utils::DateTime& value) { SetPortalLastUpdateDate(value); return *this;} /** *

The date the portal was last updated, in Unix epoch time.

*/ inline DescribePortalResult& WithPortalLastUpdateDate(Aws::Utils::DateTime&& value) { SetPortalLastUpdateDate(std::move(value)); return *this;} /** *

The portal's logo image, which is available at a URL.

*/ inline const ImageLocation& GetPortalLogoImageLocation() const{ return m_portalLogoImageLocation; } /** *

The portal's logo image, which is available at a URL.

*/ inline void SetPortalLogoImageLocation(const ImageLocation& value) { m_portalLogoImageLocation = value; } /** *

The portal's logo image, which is available at a URL.

*/ inline void SetPortalLogoImageLocation(ImageLocation&& value) { m_portalLogoImageLocation = std::move(value); } /** *

The portal's logo image, which is available at a URL.

*/ inline DescribePortalResult& WithPortalLogoImageLocation(const ImageLocation& value) { SetPortalLogoImageLocation(value); return *this;} /** *

The portal's logo image, which is available at a URL.

*/ inline DescribePortalResult& WithPortalLogoImageLocation(ImageLocation&& value) { SetPortalLogoImageLocation(std::move(value)); return *this;} /** *

The ARN * of the service role that allows the portal's users to access your IoT SiteWise * resources on your behalf. For more information, see Using * service roles for IoT SiteWise Monitor in the IoT SiteWise User * Guide.

*/ inline const Aws::String& GetRoleArn() const{ return m_roleArn; } /** *

The ARN * of the service role that allows the portal's users to access your IoT SiteWise * resources on your behalf. For more information, see Using * service roles for IoT SiteWise Monitor in the IoT SiteWise User * Guide.

*/ inline void SetRoleArn(const Aws::String& value) { m_roleArn = value; } /** *

The ARN * of the service role that allows the portal's users to access your IoT SiteWise * resources on your behalf. For more information, see Using * service roles for IoT SiteWise Monitor in the IoT SiteWise User * Guide.

*/ inline void SetRoleArn(Aws::String&& value) { m_roleArn = std::move(value); } /** *

The ARN * of the service role that allows the portal's users to access your IoT SiteWise * resources on your behalf. For more information, see Using * service roles for IoT SiteWise Monitor in the IoT SiteWise User * Guide.

*/ inline void SetRoleArn(const char* value) { m_roleArn.assign(value); } /** *

The ARN * of the service role that allows the portal's users to access your IoT SiteWise * resources on your behalf. For more information, see Using * service roles for IoT SiteWise Monitor in the IoT SiteWise User * Guide.

*/ inline DescribePortalResult& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;} /** *

The ARN * of the service role that allows the portal's users to access your IoT SiteWise * resources on your behalf. For more information, see Using * service roles for IoT SiteWise Monitor in the IoT SiteWise User * Guide.

*/ inline DescribePortalResult& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;} /** *

The ARN * of the service role that allows the portal's users to access your IoT SiteWise * resources on your behalf. For more information, see Using * service roles for IoT SiteWise Monitor in the IoT SiteWise User * Guide.

*/ inline DescribePortalResult& WithRoleArn(const char* value) { SetRoleArn(value); return *this;} /** *

The service to use to authenticate users to the portal.

*/ inline const AuthMode& GetPortalAuthMode() const{ return m_portalAuthMode; } /** *

The service to use to authenticate users to the portal.

*/ inline void SetPortalAuthMode(const AuthMode& value) { m_portalAuthMode = value; } /** *

The service to use to authenticate users to the portal.

*/ inline void SetPortalAuthMode(AuthMode&& value) { m_portalAuthMode = std::move(value); } /** *

The service to use to authenticate users to the portal.

*/ inline DescribePortalResult& WithPortalAuthMode(const AuthMode& value) { SetPortalAuthMode(value); return *this;} /** *

The service to use to authenticate users to the portal.

*/ inline DescribePortalResult& WithPortalAuthMode(AuthMode&& value) { SetPortalAuthMode(std::move(value)); return *this;} /** *

The email address that sends alarm notifications.

*/ inline const Aws::String& GetNotificationSenderEmail() const{ return m_notificationSenderEmail; } /** *

The email address that sends alarm notifications.

*/ inline void SetNotificationSenderEmail(const Aws::String& value) { m_notificationSenderEmail = value; } /** *

The email address that sends alarm notifications.

*/ inline void SetNotificationSenderEmail(Aws::String&& value) { m_notificationSenderEmail = std::move(value); } /** *

The email address that sends alarm notifications.

*/ inline void SetNotificationSenderEmail(const char* value) { m_notificationSenderEmail.assign(value); } /** *

The email address that sends alarm notifications.

*/ inline DescribePortalResult& WithNotificationSenderEmail(const Aws::String& value) { SetNotificationSenderEmail(value); return *this;} /** *

The email address that sends alarm notifications.

*/ inline DescribePortalResult& WithNotificationSenderEmail(Aws::String&& value) { SetNotificationSenderEmail(std::move(value)); return *this;} /** *

The email address that sends alarm notifications.

*/ inline DescribePortalResult& WithNotificationSenderEmail(const char* value) { SetNotificationSenderEmail(value); return *this;} /** *

Contains the configuration information of an alarm created in an IoT SiteWise * Monitor portal.

*/ inline const Alarms& GetAlarms() const{ return m_alarms; } /** *

Contains the configuration information of an alarm created in an IoT SiteWise * Monitor portal.

*/ inline void SetAlarms(const Alarms& value) { m_alarms = value; } /** *

Contains the configuration information of an alarm created in an IoT SiteWise * Monitor portal.

*/ inline void SetAlarms(Alarms&& value) { m_alarms = std::move(value); } /** *

Contains the configuration information of an alarm created in an IoT SiteWise * Monitor portal.

*/ inline DescribePortalResult& WithAlarms(const Alarms& value) { SetAlarms(value); return *this;} /** *

Contains the configuration information of an alarm created in an IoT SiteWise * Monitor portal.

*/ inline DescribePortalResult& WithAlarms(Alarms&& value) { SetAlarms(std::move(value)); return *this;} inline const Aws::String& GetRequestId() const{ return m_requestId; } inline void SetRequestId(const Aws::String& value) { m_requestId = value; } inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); } inline void SetRequestId(const char* value) { m_requestId.assign(value); } inline DescribePortalResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline DescribePortalResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline DescribePortalResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: Aws::String m_portalId; Aws::String m_portalArn; Aws::String m_portalName; Aws::String m_portalDescription; Aws::String m_portalClientId; Aws::String m_portalStartUrl; Aws::String m_portalContactEmail; PortalStatus m_portalStatus; Aws::Utils::DateTime m_portalCreationDate; Aws::Utils::DateTime m_portalLastUpdateDate; ImageLocation m_portalLogoImageLocation; Aws::String m_roleArn; AuthMode m_portalAuthMode; Aws::String m_notificationSenderEmail; Alarms m_alarms; Aws::String m_requestId; }; } // namespace Model } // namespace IoTSiteWise } // namespace Aws