/** * 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 namespace Aws { namespace IoTSiteWise { namespace Model { /** */ class UpdatePortalRequest : public IoTSiteWiseRequest { public: AWS_IOTSITEWISE_API UpdatePortalRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "UpdatePortal"; } AWS_IOTSITEWISE_API Aws::String SerializePayload() const override; /** *

The ID of the portal to update.

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

The ID of the portal to update.

*/ inline bool PortalIdHasBeenSet() const { return m_portalIdHasBeenSet; } /** *

The ID of the portal to update.

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

The ID of the portal to update.

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

The ID of the portal to update.

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

The ID of the portal to update.

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

The ID of the portal to update.

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

The ID of the portal to update.

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

A new friendly name for the portal.

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

A new friendly name for the portal.

*/ inline bool PortalNameHasBeenSet() const { return m_portalNameHasBeenSet; } /** *

A new friendly name for the portal.

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

A new friendly name for the portal.

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

A new friendly name for the portal.

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

A new friendly name for the portal.

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

A new friendly name for the portal.

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

A new friendly name for the portal.

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

A new description for the portal.

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

A new description for the portal.

*/ inline bool PortalDescriptionHasBeenSet() const { return m_portalDescriptionHasBeenSet; } /** *

A new description for the portal.

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

A new description for the portal.

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

A new description for the portal.

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

A new description for the portal.

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

A new description for the portal.

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

A new description for the portal.

*/ inline UpdatePortalRequest& WithPortalDescription(const char* value) { SetPortalDescription(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 bool PortalContactEmailHasBeenSet() const { return m_portalContactEmailHasBeenSet; } /** *

The Amazon Web Services administrator's contact email address.

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

The Amazon Web Services administrator's contact email address.

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

The Amazon Web Services administrator's contact email address.

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

The Amazon Web Services administrator's contact email address.

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

The Amazon Web Services administrator's contact email address.

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

The Amazon Web Services administrator's contact email address.

*/ inline UpdatePortalRequest& WithPortalContactEmail(const char* value) { SetPortalContactEmail(value); return *this;} inline const Image& GetPortalLogoImage() const{ return m_portalLogoImage; } inline bool PortalLogoImageHasBeenSet() const { return m_portalLogoImageHasBeenSet; } inline void SetPortalLogoImage(const Image& value) { m_portalLogoImageHasBeenSet = true; m_portalLogoImage = value; } inline void SetPortalLogoImage(Image&& value) { m_portalLogoImageHasBeenSet = true; m_portalLogoImage = std::move(value); } inline UpdatePortalRequest& WithPortalLogoImage(const Image& value) { SetPortalLogoImage(value); return *this;} inline UpdatePortalRequest& WithPortalLogoImage(Image&& value) { SetPortalLogoImage(std::move(value)); return *this;} /** *

The ARN * of a 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 a 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 bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; } /** *

The ARN * of a 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_roleArnHasBeenSet = true; m_roleArn = value; } /** *

The ARN * of a 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_roleArnHasBeenSet = true; m_roleArn = std::move(value); } /** *

The ARN * of a 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_roleArnHasBeenSet = true; m_roleArn.assign(value); } /** *

The ARN * of a 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 UpdatePortalRequest& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;} /** *

The ARN * of a 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 UpdatePortalRequest& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;} /** *

The ARN * of a 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 UpdatePortalRequest& WithRoleArn(const char* value) { SetRoleArn(value); return *this;} /** *

A unique case-sensitive identifier that you can provide to ensure the * idempotency of the request. Don't reuse this client token if a new idempotent * request is required.

*/ inline const Aws::String& GetClientToken() const{ return m_clientToken; } /** *

A unique case-sensitive identifier that you can provide to ensure the * idempotency of the request. Don't reuse this client token if a new idempotent * request is required.

*/ inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; } /** *

A unique case-sensitive identifier that you can provide to ensure the * idempotency of the request. Don't reuse this client token if a new idempotent * request is required.

*/ inline void SetClientToken(const Aws::String& value) { m_clientTokenHasBeenSet = true; m_clientToken = value; } /** *

A unique case-sensitive identifier that you can provide to ensure the * idempotency of the request. Don't reuse this client token if a new idempotent * request is required.

*/ inline void SetClientToken(Aws::String&& value) { m_clientTokenHasBeenSet = true; m_clientToken = std::move(value); } /** *

A unique case-sensitive identifier that you can provide to ensure the * idempotency of the request. Don't reuse this client token if a new idempotent * request is required.

*/ inline void SetClientToken(const char* value) { m_clientTokenHasBeenSet = true; m_clientToken.assign(value); } /** *

A unique case-sensitive identifier that you can provide to ensure the * idempotency of the request. Don't reuse this client token if a new idempotent * request is required.

*/ inline UpdatePortalRequest& WithClientToken(const Aws::String& value) { SetClientToken(value); return *this;} /** *

A unique case-sensitive identifier that you can provide to ensure the * idempotency of the request. Don't reuse this client token if a new idempotent * request is required.

*/ inline UpdatePortalRequest& WithClientToken(Aws::String&& value) { SetClientToken(std::move(value)); return *this;} /** *

A unique case-sensitive identifier that you can provide to ensure the * idempotency of the request. Don't reuse this client token if a new idempotent * request is required.

*/ inline UpdatePortalRequest& WithClientToken(const char* value) { SetClientToken(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 bool NotificationSenderEmailHasBeenSet() const { return m_notificationSenderEmailHasBeenSet; } /** *

The email address that sends alarm notifications.

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

The email address that sends alarm notifications.

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

The email address that sends alarm notifications.

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

The email address that sends alarm notifications.

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

The email address that sends alarm notifications.

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

The email address that sends alarm notifications.

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

Contains the configuration information of an alarm created in an IoT SiteWise * Monitor portal. You can use the alarm to monitor an asset property and get * notified when the asset property value is outside a specified range. For more * information, see Monitoring * with alarms in the IoT SiteWise Application Guide.

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

Contains the configuration information of an alarm created in an IoT SiteWise * Monitor portal. You can use the alarm to monitor an asset property and get * notified when the asset property value is outside a specified range. For more * information, see Monitoring * with alarms in the IoT SiteWise Application Guide.

*/ inline bool AlarmsHasBeenSet() const { return m_alarmsHasBeenSet; } /** *

Contains the configuration information of an alarm created in an IoT SiteWise * Monitor portal. You can use the alarm to monitor an asset property and get * notified when the asset property value is outside a specified range. For more * information, see Monitoring * with alarms in the IoT SiteWise Application Guide.

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

Contains the configuration information of an alarm created in an IoT SiteWise * Monitor portal. You can use the alarm to monitor an asset property and get * notified when the asset property value is outside a specified range. For more * information, see Monitoring * with alarms in the IoT SiteWise Application Guide.

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

Contains the configuration information of an alarm created in an IoT SiteWise * Monitor portal. You can use the alarm to monitor an asset property and get * notified when the asset property value is outside a specified range. For more * information, see Monitoring * with alarms in the IoT SiteWise Application Guide.

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

Contains the configuration information of an alarm created in an IoT SiteWise * Monitor portal. You can use the alarm to monitor an asset property and get * notified when the asset property value is outside a specified range. For more * information, see Monitoring * with alarms in the IoT SiteWise Application Guide.

*/ inline UpdatePortalRequest& WithAlarms(Alarms&& value) { SetAlarms(std::move(value)); return *this;} private: Aws::String m_portalId; bool m_portalIdHasBeenSet = false; Aws::String m_portalName; bool m_portalNameHasBeenSet = false; Aws::String m_portalDescription; bool m_portalDescriptionHasBeenSet = false; Aws::String m_portalContactEmail; bool m_portalContactEmailHasBeenSet = false; Image m_portalLogoImage; bool m_portalLogoImageHasBeenSet = false; Aws::String m_roleArn; bool m_roleArnHasBeenSet = false; Aws::String m_clientToken; bool m_clientTokenHasBeenSet = false; Aws::String m_notificationSenderEmail; bool m_notificationSenderEmailHasBeenSet = false; Alarms m_alarms; bool m_alarmsHasBeenSet = false; }; } // namespace Model } // namespace IoTSiteWise } // namespace Aws