/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace IoTSiteWise { namespace Model { /** *

Contains a portal summary.

See Also:

AWS * API Reference

*/ class PortalSummary { public: AWS_IOTSITEWISE_API PortalSummary(); AWS_IOTSITEWISE_API PortalSummary(Aws::Utils::Json::JsonView jsonValue); AWS_IOTSITEWISE_API PortalSummary& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_IOTSITEWISE_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The ID of the portal.

*/ inline const Aws::String& GetId() const{ return m_id; } /** *

The ID of the portal.

*/ inline bool IdHasBeenSet() const { return m_idHasBeenSet; } /** *

The ID of the portal.

*/ inline void SetId(const Aws::String& value) { m_idHasBeenSet = true; m_id = value; } /** *

The ID of the portal.

*/ inline void SetId(Aws::String&& value) { m_idHasBeenSet = true; m_id = std::move(value); } /** *

The ID of the portal.

*/ inline void SetId(const char* value) { m_idHasBeenSet = true; m_id.assign(value); } /** *

The ID of the portal.

*/ inline PortalSummary& WithId(const Aws::String& value) { SetId(value); return *this;} /** *

The ID of the portal.

*/ inline PortalSummary& WithId(Aws::String&& value) { SetId(std::move(value)); return *this;} /** *

The ID of the portal.

*/ inline PortalSummary& WithId(const char* value) { SetId(value); return *this;} /** *

The name of the portal.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the portal.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the portal.

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The name of the portal.

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The name of the portal.

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

The name of the portal.

*/ inline PortalSummary& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The name of the portal.

*/ inline PortalSummary& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The name of the portal.

*/ inline PortalSummary& WithName(const char* value) { SetName(value); return *this;} /** *

The portal's description.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

The portal's description.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

The portal's description.

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

The portal's description.

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

The portal's description.

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

The portal's description.

*/ inline PortalSummary& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

The portal's description.

*/ inline PortalSummary& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

The portal's description.

*/ inline PortalSummary& WithDescription(const char* value) { SetDescription(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& GetStartUrl() const{ return m_startUrl; } /** *

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 bool StartUrlHasBeenSet() const { return m_startUrlHasBeenSet; } /** *

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 SetStartUrl(const Aws::String& value) { m_startUrlHasBeenSet = true; m_startUrl = 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 SetStartUrl(Aws::String&& value) { m_startUrlHasBeenSet = true; m_startUrl = 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 SetStartUrl(const char* value) { m_startUrlHasBeenSet = true; m_startUrl.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 PortalSummary& WithStartUrl(const Aws::String& value) { SetStartUrl(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 PortalSummary& WithStartUrl(Aws::String&& value) { SetStartUrl(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 PortalSummary& WithStartUrl(const char* value) { SetStartUrl(value); return *this;} /** *

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

*/ inline const Aws::Utils::DateTime& GetCreationDate() const{ return m_creationDate; } /** *

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

*/ inline bool CreationDateHasBeenSet() const { return m_creationDateHasBeenSet; } /** *

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

*/ inline void SetCreationDate(const Aws::Utils::DateTime& value) { m_creationDateHasBeenSet = true; m_creationDate = value; } /** *

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

*/ inline void SetCreationDate(Aws::Utils::DateTime&& value) { m_creationDateHasBeenSet = true; m_creationDate = std::move(value); } /** *

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

*/ inline PortalSummary& WithCreationDate(const Aws::Utils::DateTime& value) { SetCreationDate(value); return *this;} /** *

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

*/ inline PortalSummary& WithCreationDate(Aws::Utils::DateTime&& value) { SetCreationDate(std::move(value)); return *this;} /** *

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

*/ inline const Aws::Utils::DateTime& GetLastUpdateDate() const{ return m_lastUpdateDate; } /** *

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

*/ inline bool LastUpdateDateHasBeenSet() const { return m_lastUpdateDateHasBeenSet; } /** *

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

*/ inline void SetLastUpdateDate(const Aws::Utils::DateTime& value) { m_lastUpdateDateHasBeenSet = true; m_lastUpdateDate = value; } /** *

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

*/ inline void SetLastUpdateDate(Aws::Utils::DateTime&& value) { m_lastUpdateDateHasBeenSet = true; m_lastUpdateDate = std::move(value); } /** *

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

*/ inline PortalSummary& WithLastUpdateDate(const Aws::Utils::DateTime& value) { SetLastUpdateDate(value); return *this;} /** *

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

*/ inline PortalSummary& WithLastUpdateDate(Aws::Utils::DateTime&& value) { SetLastUpdateDate(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 bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; } /** *

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_roleArnHasBeenSet = true; 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_roleArnHasBeenSet = true; 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_roleArnHasBeenSet = true; 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 PortalSummary& 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 PortalSummary& 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 PortalSummary& WithRoleArn(const char* value) { SetRoleArn(value); return *this;} inline const PortalStatus& GetStatus() const{ return m_status; } inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } inline void SetStatus(const PortalStatus& value) { m_statusHasBeenSet = true; m_status = value; } inline void SetStatus(PortalStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); } inline PortalSummary& WithStatus(const PortalStatus& value) { SetStatus(value); return *this;} inline PortalSummary& WithStatus(PortalStatus&& value) { SetStatus(std::move(value)); return *this;} private: Aws::String m_id; bool m_idHasBeenSet = false; Aws::String m_name; bool m_nameHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; Aws::String m_startUrl; bool m_startUrlHasBeenSet = false; Aws::Utils::DateTime m_creationDate; bool m_creationDateHasBeenSet = false; Aws::Utils::DateTime m_lastUpdateDate; bool m_lastUpdateDateHasBeenSet = false; Aws::String m_roleArn; bool m_roleArnHasBeenSet = false; PortalStatus m_status; bool m_statusHasBeenSet = false; }; } // namespace Model } // namespace IoTSiteWise } // namespace Aws