AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoTSiteWise::Model::PortalSummary Class Reference

#include <PortalSummary.h>

Public Member Functions

 PortalSummary ()
 
 PortalSummary (Aws::Utils::Json::JsonView jsonValue)
 
PortalSummaryoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
PortalSummaryWithId (const Aws::String &value)
 
PortalSummaryWithId (Aws::String &&value)
 
PortalSummaryWithId (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
PortalSummaryWithName (const Aws::String &value)
 
PortalSummaryWithName (Aws::String &&value)
 
PortalSummaryWithName (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
PortalSummaryWithDescription (const Aws::String &value)
 
PortalSummaryWithDescription (Aws::String &&value)
 
PortalSummaryWithDescription (const char *value)
 
const Aws::StringGetStartUrl () const
 
bool StartUrlHasBeenSet () const
 
void SetStartUrl (const Aws::String &value)
 
void SetStartUrl (Aws::String &&value)
 
void SetStartUrl (const char *value)
 
PortalSummaryWithStartUrl (const Aws::String &value)
 
PortalSummaryWithStartUrl (Aws::String &&value)
 
PortalSummaryWithStartUrl (const char *value)
 
const Aws::Utils::DateTimeGetCreationDate () const
 
bool CreationDateHasBeenSet () const
 
void SetCreationDate (const Aws::Utils::DateTime &value)
 
void SetCreationDate (Aws::Utils::DateTime &&value)
 
PortalSummaryWithCreationDate (const Aws::Utils::DateTime &value)
 
PortalSummaryWithCreationDate (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastUpdateDate () const
 
bool LastUpdateDateHasBeenSet () const
 
void SetLastUpdateDate (const Aws::Utils::DateTime &value)
 
void SetLastUpdateDate (Aws::Utils::DateTime &&value)
 
PortalSummaryWithLastUpdateDate (const Aws::Utils::DateTime &value)
 
PortalSummaryWithLastUpdateDate (Aws::Utils::DateTime &&value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
PortalSummaryWithRoleArn (const Aws::String &value)
 
PortalSummaryWithRoleArn (Aws::String &&value)
 
PortalSummaryWithRoleArn (const char *value)
 
const PortalStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const PortalStatus &value)
 
void SetStatus (PortalStatus &&value)
 
PortalSummaryWithStatus (const PortalStatus &value)
 
PortalSummaryWithStatus (PortalStatus &&value)
 

Detailed Description

Contains a portal summary.

See Also:

AWS API Reference

Definition at line 33 of file PortalSummary.h.

Constructor & Destructor Documentation

◆ PortalSummary() [1/2]

Aws::IoTSiteWise::Model::PortalSummary::PortalSummary ( )

◆ PortalSummary() [2/2]

Aws::IoTSiteWise::Model::PortalSummary::PortalSummary ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ CreationDateHasBeenSet()

bool Aws::IoTSiteWise::Model::PortalSummary::CreationDateHasBeenSet ( ) const
inline

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

Definition at line 254 of file PortalSummary.h.

◆ DescriptionHasBeenSet()

bool Aws::IoTSiteWise::Model::PortalSummary::DescriptionHasBeenSet ( ) const
inline

The portal's description.

Definition at line 132 of file PortalSummary.h.

◆ GetCreationDate()

const Aws::Utils::DateTime& Aws::IoTSiteWise::Model::PortalSummary::GetCreationDate ( ) const
inline

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

Definition at line 249 of file PortalSummary.h.

◆ GetDescription()

const Aws::String& Aws::IoTSiteWise::Model::PortalSummary::GetDescription ( ) const
inline

The portal's description.

Definition at line 127 of file PortalSummary.h.

◆ GetId()

const Aws::String& Aws::IoTSiteWise::Model::PortalSummary::GetId ( ) const
inline

The ID of the portal.

Definition at line 45 of file PortalSummary.h.

◆ GetLastUpdateDate()

const Aws::Utils::DateTime& Aws::IoTSiteWise::Model::PortalSummary::GetLastUpdateDate ( ) const
inline

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

Definition at line 280 of file PortalSummary.h.

◆ GetName()

const Aws::String& Aws::IoTSiteWise::Model::PortalSummary::GetName ( ) const
inline

The name of the portal.

Definition at line 86 of file PortalSummary.h.

◆ GetRoleArn()

const Aws::String& Aws::IoTSiteWise::Model::PortalSummary::GetRoleArn ( ) const
inline

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

Definition at line 317 of file PortalSummary.h.

◆ GetStartUrl()

const Aws::String& Aws::IoTSiteWise::Model::PortalSummary::GetStartUrl ( ) const
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 173 of file PortalSummary.h.

◆ GetStatus()

const PortalStatus& Aws::IoTSiteWise::Model::PortalSummary::GetStatus ( ) const
inline

Definition at line 398 of file PortalSummary.h.

◆ IdHasBeenSet()

bool Aws::IoTSiteWise::Model::PortalSummary::IdHasBeenSet ( ) const
inline

The ID of the portal.

Definition at line 50 of file PortalSummary.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::IoTSiteWise::Model::PortalSummary::Jsonize ( ) const

◆ LastUpdateDateHasBeenSet()

bool Aws::IoTSiteWise::Model::PortalSummary::LastUpdateDateHasBeenSet ( ) const
inline

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

Definition at line 285 of file PortalSummary.h.

◆ NameHasBeenSet()

bool Aws::IoTSiteWise::Model::PortalSummary::NameHasBeenSet ( ) const
inline

The name of the portal.

Definition at line 91 of file PortalSummary.h.

◆ operator=()

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RoleArnHasBeenSet()

bool Aws::IoTSiteWise::Model::PortalSummary::RoleArnHasBeenSet ( ) const
inline

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

Definition at line 328 of file PortalSummary.h.

◆ SetCreationDate() [1/2]

void Aws::IoTSiteWise::Model::PortalSummary::SetCreationDate ( const Aws::Utils::DateTime value)
inline

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

Definition at line 259 of file PortalSummary.h.

◆ SetCreationDate() [2/2]

void Aws::IoTSiteWise::Model::PortalSummary::SetCreationDate ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 264 of file PortalSummary.h.

◆ SetDescription() [1/3]

void Aws::IoTSiteWise::Model::PortalSummary::SetDescription ( const Aws::String value)
inline

The portal's description.

Definition at line 137 of file PortalSummary.h.

◆ SetDescription() [2/3]

void Aws::IoTSiteWise::Model::PortalSummary::SetDescription ( Aws::String &&  value)
inline

The portal's description.

Definition at line 142 of file PortalSummary.h.

◆ SetDescription() [3/3]

void Aws::IoTSiteWise::Model::PortalSummary::SetDescription ( const char *  value)
inline

The portal's description.

Definition at line 147 of file PortalSummary.h.

◆ SetId() [1/3]

void Aws::IoTSiteWise::Model::PortalSummary::SetId ( const Aws::String value)
inline

The ID of the portal.

Definition at line 55 of file PortalSummary.h.

◆ SetId() [2/3]

void Aws::IoTSiteWise::Model::PortalSummary::SetId ( Aws::String &&  value)
inline

The ID of the portal.

Definition at line 60 of file PortalSummary.h.

◆ SetId() [3/3]

void Aws::IoTSiteWise::Model::PortalSummary::SetId ( const char *  value)
inline

The ID of the portal.

Definition at line 65 of file PortalSummary.h.

◆ SetLastUpdateDate() [1/2]

void Aws::IoTSiteWise::Model::PortalSummary::SetLastUpdateDate ( const Aws::Utils::DateTime value)
inline

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

Definition at line 290 of file PortalSummary.h.

◆ SetLastUpdateDate() [2/2]

void Aws::IoTSiteWise::Model::PortalSummary::SetLastUpdateDate ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 295 of file PortalSummary.h.

◆ SetName() [1/3]

void Aws::IoTSiteWise::Model::PortalSummary::SetName ( const Aws::String value)
inline

The name of the portal.

Definition at line 96 of file PortalSummary.h.

◆ SetName() [2/3]

void Aws::IoTSiteWise::Model::PortalSummary::SetName ( Aws::String &&  value)
inline

The name of the portal.

Definition at line 101 of file PortalSummary.h.

◆ SetName() [3/3]

void Aws::IoTSiteWise::Model::PortalSummary::SetName ( const char *  value)
inline

The name of the portal.

Definition at line 106 of file PortalSummary.h.

◆ SetRoleArn() [1/3]

void Aws::IoTSiteWise::Model::PortalSummary::SetRoleArn ( const Aws::String value)
inline

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

Definition at line 339 of file PortalSummary.h.

◆ SetRoleArn() [2/3]

void Aws::IoTSiteWise::Model::PortalSummary::SetRoleArn ( Aws::String &&  value)
inline

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

Definition at line 350 of file PortalSummary.h.

◆ SetRoleArn() [3/3]

void Aws::IoTSiteWise::Model::PortalSummary::SetRoleArn ( const char *  value)
inline

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

Definition at line 361 of file PortalSummary.h.

◆ SetStartUrl() [1/3]

void Aws::IoTSiteWise::Model::PortalSummary::SetStartUrl ( const Aws::String value)
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 193 of file PortalSummary.h.

◆ SetStartUrl() [2/3]

void Aws::IoTSiteWise::Model::PortalSummary::SetStartUrl ( Aws::String &&  value)
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 203 of file PortalSummary.h.

◆ SetStartUrl() [3/3]

void Aws::IoTSiteWise::Model::PortalSummary::SetStartUrl ( const char *  value)
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 213 of file PortalSummary.h.

◆ SetStatus() [1/2]

void Aws::IoTSiteWise::Model::PortalSummary::SetStatus ( const PortalStatus value)
inline

Definition at line 404 of file PortalSummary.h.

◆ SetStatus() [2/2]

void Aws::IoTSiteWise::Model::PortalSummary::SetStatus ( PortalStatus &&  value)
inline

Definition at line 407 of file PortalSummary.h.

◆ StartUrlHasBeenSet()

bool Aws::IoTSiteWise::Model::PortalSummary::StartUrlHasBeenSet ( ) const
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 183 of file PortalSummary.h.

◆ StatusHasBeenSet()

bool Aws::IoTSiteWise::Model::PortalSummary::StatusHasBeenSet ( ) const
inline

Definition at line 401 of file PortalSummary.h.

◆ WithCreationDate() [1/2]

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::WithCreationDate ( const Aws::Utils::DateTime value)
inline

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

Definition at line 269 of file PortalSummary.h.

◆ WithCreationDate() [2/2]

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::WithCreationDate ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 274 of file PortalSummary.h.

◆ WithDescription() [1/3]

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::WithDescription ( const Aws::String value)
inline

The portal's description.

Definition at line 152 of file PortalSummary.h.

◆ WithDescription() [2/3]

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::WithDescription ( Aws::String &&  value)
inline

The portal's description.

Definition at line 157 of file PortalSummary.h.

◆ WithDescription() [3/3]

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::WithDescription ( const char *  value)
inline

The portal's description.

Definition at line 162 of file PortalSummary.h.

◆ WithId() [1/3]

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::WithId ( const Aws::String value)
inline

The ID of the portal.

Definition at line 70 of file PortalSummary.h.

◆ WithId() [2/3]

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::WithId ( Aws::String &&  value)
inline

The ID of the portal.

Definition at line 75 of file PortalSummary.h.

◆ WithId() [3/3]

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::WithId ( const char *  value)
inline

The ID of the portal.

Definition at line 80 of file PortalSummary.h.

◆ WithLastUpdateDate() [1/2]

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::WithLastUpdateDate ( const Aws::Utils::DateTime value)
inline

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

Definition at line 300 of file PortalSummary.h.

◆ WithLastUpdateDate() [2/2]

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::WithLastUpdateDate ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 305 of file PortalSummary.h.

◆ WithName() [1/3]

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::WithName ( const Aws::String value)
inline

The name of the portal.

Definition at line 111 of file PortalSummary.h.

◆ WithName() [2/3]

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::WithName ( Aws::String &&  value)
inline

The name of the portal.

Definition at line 116 of file PortalSummary.h.

◆ WithName() [3/3]

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::WithName ( const char *  value)
inline

The name of the portal.

Definition at line 121 of file PortalSummary.h.

◆ WithRoleArn() [1/3]

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::WithRoleArn ( const Aws::String value)
inline

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

Definition at line 372 of file PortalSummary.h.

◆ WithRoleArn() [2/3]

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::WithRoleArn ( Aws::String &&  value)
inline

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

Definition at line 383 of file PortalSummary.h.

◆ WithRoleArn() [3/3]

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::WithRoleArn ( const char *  value)
inline

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

Definition at line 394 of file PortalSummary.h.

◆ WithStartUrl() [1/3]

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::WithStartUrl ( const Aws::String value)
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 223 of file PortalSummary.h.

◆ WithStartUrl() [2/3]

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::WithStartUrl ( Aws::String &&  value)
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 233 of file PortalSummary.h.

◆ WithStartUrl() [3/3]

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::WithStartUrl ( const char *  value)
inline

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Definition at line 243 of file PortalSummary.h.

◆ WithStatus() [1/2]

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::WithStatus ( const PortalStatus value)
inline

Definition at line 410 of file PortalSummary.h.

◆ WithStatus() [2/2]

PortalSummary& Aws::IoTSiteWise::Model::PortalSummary::WithStatus ( PortalStatus &&  value)
inline

Definition at line 413 of file PortalSummary.h.


The documentation for this class was generated from the following file: