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

#include <UpdatePortalRequest.h>

+ Inheritance diagram for Aws::IoTSiteWise::Model::UpdatePortalRequest:

Public Member Functions

 UpdatePortalRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetPortalId () const
 
bool PortalIdHasBeenSet () const
 
void SetPortalId (const Aws::String &value)
 
void SetPortalId (Aws::String &&value)
 
void SetPortalId (const char *value)
 
UpdatePortalRequestWithPortalId (const Aws::String &value)
 
UpdatePortalRequestWithPortalId (Aws::String &&value)
 
UpdatePortalRequestWithPortalId (const char *value)
 
const Aws::StringGetPortalName () const
 
bool PortalNameHasBeenSet () const
 
void SetPortalName (const Aws::String &value)
 
void SetPortalName (Aws::String &&value)
 
void SetPortalName (const char *value)
 
UpdatePortalRequestWithPortalName (const Aws::String &value)
 
UpdatePortalRequestWithPortalName (Aws::String &&value)
 
UpdatePortalRequestWithPortalName (const char *value)
 
const Aws::StringGetPortalDescription () const
 
bool PortalDescriptionHasBeenSet () const
 
void SetPortalDescription (const Aws::String &value)
 
void SetPortalDescription (Aws::String &&value)
 
void SetPortalDescription (const char *value)
 
UpdatePortalRequestWithPortalDescription (const Aws::String &value)
 
UpdatePortalRequestWithPortalDescription (Aws::String &&value)
 
UpdatePortalRequestWithPortalDescription (const char *value)
 
const Aws::StringGetPortalContactEmail () const
 
bool PortalContactEmailHasBeenSet () const
 
void SetPortalContactEmail (const Aws::String &value)
 
void SetPortalContactEmail (Aws::String &&value)
 
void SetPortalContactEmail (const char *value)
 
UpdatePortalRequestWithPortalContactEmail (const Aws::String &value)
 
UpdatePortalRequestWithPortalContactEmail (Aws::String &&value)
 
UpdatePortalRequestWithPortalContactEmail (const char *value)
 
const ImageGetPortalLogoImage () const
 
bool PortalLogoImageHasBeenSet () const
 
void SetPortalLogoImage (const Image &value)
 
void SetPortalLogoImage (Image &&value)
 
UpdatePortalRequestWithPortalLogoImage (const Image &value)
 
UpdatePortalRequestWithPortalLogoImage (Image &&value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
UpdatePortalRequestWithRoleArn (const Aws::String &value)
 
UpdatePortalRequestWithRoleArn (Aws::String &&value)
 
UpdatePortalRequestWithRoleArn (const char *value)
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
UpdatePortalRequestWithClientToken (const Aws::String &value)
 
UpdatePortalRequestWithClientToken (Aws::String &&value)
 
UpdatePortalRequestWithClientToken (const char *value)
 
- Public Member Functions inherited from Aws::IoTSiteWise::IoTSiteWiseRequest
virtual ~IoTSiteWiseRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::IoTSiteWise::IoTSiteWiseRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 23 of file UpdatePortalRequest.h.

Constructor & Destructor Documentation

◆ UpdatePortalRequest()

Aws::IoTSiteWise::Model::UpdatePortalRequest::UpdatePortalRequest ( )

Member Function Documentation

◆ ClientTokenHasBeenSet()

bool Aws::IoTSiteWise::Model::UpdatePortalRequest::ClientTokenHasBeenSet ( ) const
inline

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.

Definition at line 321 of file UpdatePortalRequest.h.

◆ GetClientToken()

const Aws::String& Aws::IoTSiteWise::Model::UpdatePortalRequest::GetClientToken ( ) const
inline

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.

Definition at line 314 of file UpdatePortalRequest.h.

◆ GetPortalContactEmail()

const Aws::String& Aws::IoTSiteWise::Model::UpdatePortalRequest::GetPortalContactEmail ( ) const
inline

The AWS administrator's contact email address.

Definition at line 163 of file UpdatePortalRequest.h.

◆ GetPortalDescription()

const Aws::String& Aws::IoTSiteWise::Model::UpdatePortalRequest::GetPortalDescription ( ) const
inline

A new description for the portal.

Definition at line 122 of file UpdatePortalRequest.h.

◆ GetPortalId()

const Aws::String& Aws::IoTSiteWise::Model::UpdatePortalRequest::GetPortalId ( ) const
inline

The ID of the portal to update.

Definition at line 40 of file UpdatePortalRequest.h.

◆ GetPortalLogoImage()

const Image& Aws::IoTSiteWise::Model::UpdatePortalRequest::GetPortalLogoImage ( ) const
inline

Definition at line 202 of file UpdatePortalRequest.h.

◆ GetPortalName()

const Aws::String& Aws::IoTSiteWise::Model::UpdatePortalRequest::GetPortalName ( ) const
inline

A new friendly name for the portal.

Definition at line 81 of file UpdatePortalRequest.h.

◆ GetRoleArn()

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

The ARN of a 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 229 of file UpdatePortalRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::IoTSiteWise::Model::UpdatePortalRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file UpdatePortalRequest.h.

◆ PortalContactEmailHasBeenSet()

bool Aws::IoTSiteWise::Model::UpdatePortalRequest::PortalContactEmailHasBeenSet ( ) const
inline

The AWS administrator's contact email address.

Definition at line 168 of file UpdatePortalRequest.h.

◆ PortalDescriptionHasBeenSet()

bool Aws::IoTSiteWise::Model::UpdatePortalRequest::PortalDescriptionHasBeenSet ( ) const
inline

A new description for the portal.

Definition at line 127 of file UpdatePortalRequest.h.

◆ PortalIdHasBeenSet()

bool Aws::IoTSiteWise::Model::UpdatePortalRequest::PortalIdHasBeenSet ( ) const
inline

The ID of the portal to update.

Definition at line 45 of file UpdatePortalRequest.h.

◆ PortalLogoImageHasBeenSet()

bool Aws::IoTSiteWise::Model::UpdatePortalRequest::PortalLogoImageHasBeenSet ( ) const
inline

Definition at line 205 of file UpdatePortalRequest.h.

◆ PortalNameHasBeenSet()

bool Aws::IoTSiteWise::Model::UpdatePortalRequest::PortalNameHasBeenSet ( ) const
inline

A new friendly name for the portal.

Definition at line 86 of file UpdatePortalRequest.h.

◆ RoleArnHasBeenSet()

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

The ARN of a 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 240 of file UpdatePortalRequest.h.

◆ SerializePayload()

Aws::String Aws::IoTSiteWise::Model::UpdatePortalRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientToken() [1/3]

void Aws::IoTSiteWise::Model::UpdatePortalRequest::SetClientToken ( const Aws::String value)
inline

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.

Definition at line 328 of file UpdatePortalRequest.h.

◆ SetClientToken() [2/3]

void Aws::IoTSiteWise::Model::UpdatePortalRequest::SetClientToken ( Aws::String &&  value)
inline

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.

Definition at line 335 of file UpdatePortalRequest.h.

◆ SetClientToken() [3/3]

void Aws::IoTSiteWise::Model::UpdatePortalRequest::SetClientToken ( const char *  value)
inline

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.

Definition at line 342 of file UpdatePortalRequest.h.

◆ SetPortalContactEmail() [1/3]

void Aws::IoTSiteWise::Model::UpdatePortalRequest::SetPortalContactEmail ( const Aws::String value)
inline

The AWS administrator's contact email address.

Definition at line 173 of file UpdatePortalRequest.h.

◆ SetPortalContactEmail() [2/3]

void Aws::IoTSiteWise::Model::UpdatePortalRequest::SetPortalContactEmail ( Aws::String &&  value)
inline

The AWS administrator's contact email address.

Definition at line 178 of file UpdatePortalRequest.h.

◆ SetPortalContactEmail() [3/3]

void Aws::IoTSiteWise::Model::UpdatePortalRequest::SetPortalContactEmail ( const char *  value)
inline

The AWS administrator's contact email address.

Definition at line 183 of file UpdatePortalRequest.h.

◆ SetPortalDescription() [1/3]

void Aws::IoTSiteWise::Model::UpdatePortalRequest::SetPortalDescription ( const Aws::String value)
inline

A new description for the portal.

Definition at line 132 of file UpdatePortalRequest.h.

◆ SetPortalDescription() [2/3]

void Aws::IoTSiteWise::Model::UpdatePortalRequest::SetPortalDescription ( Aws::String &&  value)
inline

A new description for the portal.

Definition at line 137 of file UpdatePortalRequest.h.

◆ SetPortalDescription() [3/3]

void Aws::IoTSiteWise::Model::UpdatePortalRequest::SetPortalDescription ( const char *  value)
inline

A new description for the portal.

Definition at line 142 of file UpdatePortalRequest.h.

◆ SetPortalId() [1/3]

void Aws::IoTSiteWise::Model::UpdatePortalRequest::SetPortalId ( const Aws::String value)
inline

The ID of the portal to update.

Definition at line 50 of file UpdatePortalRequest.h.

◆ SetPortalId() [2/3]

void Aws::IoTSiteWise::Model::UpdatePortalRequest::SetPortalId ( Aws::String &&  value)
inline

The ID of the portal to update.

Definition at line 55 of file UpdatePortalRequest.h.

◆ SetPortalId() [3/3]

void Aws::IoTSiteWise::Model::UpdatePortalRequest::SetPortalId ( const char *  value)
inline

The ID of the portal to update.

Definition at line 60 of file UpdatePortalRequest.h.

◆ SetPortalLogoImage() [1/2]

void Aws::IoTSiteWise::Model::UpdatePortalRequest::SetPortalLogoImage ( const Image value)
inline

Definition at line 208 of file UpdatePortalRequest.h.

◆ SetPortalLogoImage() [2/2]

void Aws::IoTSiteWise::Model::UpdatePortalRequest::SetPortalLogoImage ( Image &&  value)
inline

Definition at line 211 of file UpdatePortalRequest.h.

◆ SetPortalName() [1/3]

void Aws::IoTSiteWise::Model::UpdatePortalRequest::SetPortalName ( const Aws::String value)
inline

A new friendly name for the portal.

Definition at line 91 of file UpdatePortalRequest.h.

◆ SetPortalName() [2/3]

void Aws::IoTSiteWise::Model::UpdatePortalRequest::SetPortalName ( Aws::String &&  value)
inline

A new friendly name for the portal.

Definition at line 96 of file UpdatePortalRequest.h.

◆ SetPortalName() [3/3]

void Aws::IoTSiteWise::Model::UpdatePortalRequest::SetPortalName ( const char *  value)
inline

A new friendly name for the portal.

Definition at line 101 of file UpdatePortalRequest.h.

◆ SetRoleArn() [1/3]

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

The ARN of a 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 251 of file UpdatePortalRequest.h.

◆ SetRoleArn() [2/3]

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

The ARN of a 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 262 of file UpdatePortalRequest.h.

◆ SetRoleArn() [3/3]

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

The ARN of a 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 273 of file UpdatePortalRequest.h.

◆ WithClientToken() [1/3]

UpdatePortalRequest& Aws::IoTSiteWise::Model::UpdatePortalRequest::WithClientToken ( const Aws::String value)
inline

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.

Definition at line 349 of file UpdatePortalRequest.h.

◆ WithClientToken() [2/3]

UpdatePortalRequest& Aws::IoTSiteWise::Model::UpdatePortalRequest::WithClientToken ( Aws::String &&  value)
inline

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.

Definition at line 356 of file UpdatePortalRequest.h.

◆ WithClientToken() [3/3]

UpdatePortalRequest& Aws::IoTSiteWise::Model::UpdatePortalRequest::WithClientToken ( const char *  value)
inline

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.

Definition at line 363 of file UpdatePortalRequest.h.

◆ WithPortalContactEmail() [1/3]

UpdatePortalRequest& Aws::IoTSiteWise::Model::UpdatePortalRequest::WithPortalContactEmail ( const Aws::String value)
inline

The AWS administrator's contact email address.

Definition at line 188 of file UpdatePortalRequest.h.

◆ WithPortalContactEmail() [2/3]

UpdatePortalRequest& Aws::IoTSiteWise::Model::UpdatePortalRequest::WithPortalContactEmail ( Aws::String &&  value)
inline

The AWS administrator's contact email address.

Definition at line 193 of file UpdatePortalRequest.h.

◆ WithPortalContactEmail() [3/3]

UpdatePortalRequest& Aws::IoTSiteWise::Model::UpdatePortalRequest::WithPortalContactEmail ( const char *  value)
inline

The AWS administrator's contact email address.

Definition at line 198 of file UpdatePortalRequest.h.

◆ WithPortalDescription() [1/3]

UpdatePortalRequest& Aws::IoTSiteWise::Model::UpdatePortalRequest::WithPortalDescription ( const Aws::String value)
inline

A new description for the portal.

Definition at line 147 of file UpdatePortalRequest.h.

◆ WithPortalDescription() [2/3]

UpdatePortalRequest& Aws::IoTSiteWise::Model::UpdatePortalRequest::WithPortalDescription ( Aws::String &&  value)
inline

A new description for the portal.

Definition at line 152 of file UpdatePortalRequest.h.

◆ WithPortalDescription() [3/3]

UpdatePortalRequest& Aws::IoTSiteWise::Model::UpdatePortalRequest::WithPortalDescription ( const char *  value)
inline

A new description for the portal.

Definition at line 157 of file UpdatePortalRequest.h.

◆ WithPortalId() [1/3]

UpdatePortalRequest& Aws::IoTSiteWise::Model::UpdatePortalRequest::WithPortalId ( const Aws::String value)
inline

The ID of the portal to update.

Definition at line 65 of file UpdatePortalRequest.h.

◆ WithPortalId() [2/3]

UpdatePortalRequest& Aws::IoTSiteWise::Model::UpdatePortalRequest::WithPortalId ( Aws::String &&  value)
inline

The ID of the portal to update.

Definition at line 70 of file UpdatePortalRequest.h.

◆ WithPortalId() [3/3]

UpdatePortalRequest& Aws::IoTSiteWise::Model::UpdatePortalRequest::WithPortalId ( const char *  value)
inline

The ID of the portal to update.

Definition at line 75 of file UpdatePortalRequest.h.

◆ WithPortalLogoImage() [1/2]

UpdatePortalRequest& Aws::IoTSiteWise::Model::UpdatePortalRequest::WithPortalLogoImage ( const Image value)
inline

Definition at line 214 of file UpdatePortalRequest.h.

◆ WithPortalLogoImage() [2/2]

UpdatePortalRequest& Aws::IoTSiteWise::Model::UpdatePortalRequest::WithPortalLogoImage ( Image &&  value)
inline

Definition at line 217 of file UpdatePortalRequest.h.

◆ WithPortalName() [1/3]

UpdatePortalRequest& Aws::IoTSiteWise::Model::UpdatePortalRequest::WithPortalName ( const Aws::String value)
inline

A new friendly name for the portal.

Definition at line 106 of file UpdatePortalRequest.h.

◆ WithPortalName() [2/3]

UpdatePortalRequest& Aws::IoTSiteWise::Model::UpdatePortalRequest::WithPortalName ( Aws::String &&  value)
inline

A new friendly name for the portal.

Definition at line 111 of file UpdatePortalRequest.h.

◆ WithPortalName() [3/3]

UpdatePortalRequest& Aws::IoTSiteWise::Model::UpdatePortalRequest::WithPortalName ( const char *  value)
inline

A new friendly name for the portal.

Definition at line 116 of file UpdatePortalRequest.h.

◆ WithRoleArn() [1/3]

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

The ARN of a 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 284 of file UpdatePortalRequest.h.

◆ WithRoleArn() [2/3]

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

The ARN of a 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 295 of file UpdatePortalRequest.h.

◆ WithRoleArn() [3/3]

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

The ARN of a 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 306 of file UpdatePortalRequest.h.


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