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

#include <UpdateTemplateRequest.h>

+ Inheritance diagram for Aws::QuickSight::Model::UpdateTemplateRequest:

Public Member Functions

 UpdateTemplateRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetAwsAccountId () const
 
bool AwsAccountIdHasBeenSet () const
 
void SetAwsAccountId (const Aws::String &value)
 
void SetAwsAccountId (Aws::String &&value)
 
void SetAwsAccountId (const char *value)
 
UpdateTemplateRequestWithAwsAccountId (const Aws::String &value)
 
UpdateTemplateRequestWithAwsAccountId (Aws::String &&value)
 
UpdateTemplateRequestWithAwsAccountId (const char *value)
 
const Aws::StringGetTemplateId () const
 
bool TemplateIdHasBeenSet () const
 
void SetTemplateId (const Aws::String &value)
 
void SetTemplateId (Aws::String &&value)
 
void SetTemplateId (const char *value)
 
UpdateTemplateRequestWithTemplateId (const Aws::String &value)
 
UpdateTemplateRequestWithTemplateId (Aws::String &&value)
 
UpdateTemplateRequestWithTemplateId (const char *value)
 
const TemplateSourceEntityGetSourceEntity () const
 
bool SourceEntityHasBeenSet () const
 
void SetSourceEntity (const TemplateSourceEntity &value)
 
void SetSourceEntity (TemplateSourceEntity &&value)
 
UpdateTemplateRequestWithSourceEntity (const TemplateSourceEntity &value)
 
UpdateTemplateRequestWithSourceEntity (TemplateSourceEntity &&value)
 
const Aws::StringGetVersionDescription () const
 
bool VersionDescriptionHasBeenSet () const
 
void SetVersionDescription (const Aws::String &value)
 
void SetVersionDescription (Aws::String &&value)
 
void SetVersionDescription (const char *value)
 
UpdateTemplateRequestWithVersionDescription (const Aws::String &value)
 
UpdateTemplateRequestWithVersionDescription (Aws::String &&value)
 
UpdateTemplateRequestWithVersionDescription (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)
 
UpdateTemplateRequestWithName (const Aws::String &value)
 
UpdateTemplateRequestWithName (Aws::String &&value)
 
UpdateTemplateRequestWithName (const char *value)
 
- Public Member Functions inherited from Aws::QuickSight::QuickSightRequest
virtual ~QuickSightRequest ()
 
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::QuickSight::QuickSightRequest
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 22 of file UpdateTemplateRequest.h.

Constructor & Destructor Documentation

◆ UpdateTemplateRequest()

Aws::QuickSight::Model::UpdateTemplateRequest::UpdateTemplateRequest ( )

Member Function Documentation

◆ AwsAccountIdHasBeenSet()

bool Aws::QuickSight::Model::UpdateTemplateRequest::AwsAccountIdHasBeenSet ( ) const
inline

The ID of the AWS account that contains the template that you're updating.

Definition at line 46 of file UpdateTemplateRequest.h.

◆ GetAwsAccountId()

const Aws::String& Aws::QuickSight::Model::UpdateTemplateRequest::GetAwsAccountId ( ) const
inline

The ID of the AWS account that contains the template that you're updating.

Definition at line 40 of file UpdateTemplateRequest.h.

◆ GetName()

const Aws::String& Aws::QuickSight::Model::UpdateTemplateRequest::GetName ( ) const
inline

The name for the template.

Definition at line 291 of file UpdateTemplateRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::QuickSight::Model::UpdateTemplateRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file UpdateTemplateRequest.h.

◆ GetSourceEntity()

const TemplateSourceEntity& Aws::QuickSight::Model::UpdateTemplateRequest::GetSourceEntity ( ) const
inline

The entity that you are using as a source when you update the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.

Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Definition at line 140 of file UpdateTemplateRequest.h.

◆ GetTemplateId()

const Aws::String& Aws::QuickSight::Model::UpdateTemplateRequest::GetTemplateId ( ) const
inline

The ID for the template.

Definition at line 88 of file UpdateTemplateRequest.h.

◆ GetVersionDescription()

const Aws::String& Aws::QuickSight::Model::UpdateTemplateRequest::GetVersionDescription ( ) const
inline

A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.

Definition at line 229 of file UpdateTemplateRequest.h.

◆ NameHasBeenSet()

bool Aws::QuickSight::Model::UpdateTemplateRequest::NameHasBeenSet ( ) const
inline

The name for the template.

Definition at line 296 of file UpdateTemplateRequest.h.

◆ SerializePayload()

Aws::String Aws::QuickSight::Model::UpdateTemplateRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAwsAccountId() [1/3]

void Aws::QuickSight::Model::UpdateTemplateRequest::SetAwsAccountId ( const Aws::String value)
inline

The ID of the AWS account that contains the template that you're updating.

Definition at line 52 of file UpdateTemplateRequest.h.

◆ SetAwsAccountId() [2/3]

void Aws::QuickSight::Model::UpdateTemplateRequest::SetAwsAccountId ( Aws::String &&  value)
inline

The ID of the AWS account that contains the template that you're updating.

Definition at line 58 of file UpdateTemplateRequest.h.

◆ SetAwsAccountId() [3/3]

void Aws::QuickSight::Model::UpdateTemplateRequest::SetAwsAccountId ( const char *  value)
inline

The ID of the AWS account that contains the template that you're updating.

Definition at line 64 of file UpdateTemplateRequest.h.

◆ SetName() [1/3]

void Aws::QuickSight::Model::UpdateTemplateRequest::SetName ( const Aws::String value)
inline

The name for the template.

Definition at line 301 of file UpdateTemplateRequest.h.

◆ SetName() [2/3]

void Aws::QuickSight::Model::UpdateTemplateRequest::SetName ( Aws::String &&  value)
inline

The name for the template.

Definition at line 306 of file UpdateTemplateRequest.h.

◆ SetName() [3/3]

void Aws::QuickSight::Model::UpdateTemplateRequest::SetName ( const char *  value)
inline

The name for the template.

Definition at line 311 of file UpdateTemplateRequest.h.

◆ SetSourceEntity() [1/2]

void Aws::QuickSight::Model::UpdateTemplateRequest::SetSourceEntity ( const TemplateSourceEntity value)
inline

The entity that you are using as a source when you update the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.

Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Definition at line 172 of file UpdateTemplateRequest.h.

◆ SetSourceEntity() [2/2]

void Aws::QuickSight::Model::UpdateTemplateRequest::SetSourceEntity ( TemplateSourceEntity &&  value)
inline

The entity that you are using as a source when you update the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.

Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Definition at line 188 of file UpdateTemplateRequest.h.

◆ SetTemplateId() [1/3]

void Aws::QuickSight::Model::UpdateTemplateRequest::SetTemplateId ( const Aws::String value)
inline

The ID for the template.

Definition at line 98 of file UpdateTemplateRequest.h.

◆ SetTemplateId() [2/3]

void Aws::QuickSight::Model::UpdateTemplateRequest::SetTemplateId ( Aws::String &&  value)
inline

The ID for the template.

Definition at line 103 of file UpdateTemplateRequest.h.

◆ SetTemplateId() [3/3]

void Aws::QuickSight::Model::UpdateTemplateRequest::SetTemplateId ( const char *  value)
inline

The ID for the template.

Definition at line 108 of file UpdateTemplateRequest.h.

◆ SetVersionDescription() [1/3]

void Aws::QuickSight::Model::UpdateTemplateRequest::SetVersionDescription ( const Aws::String value)
inline

A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.

Definition at line 245 of file UpdateTemplateRequest.h.

◆ SetVersionDescription() [2/3]

void Aws::QuickSight::Model::UpdateTemplateRequest::SetVersionDescription ( Aws::String &&  value)
inline

A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.

Definition at line 253 of file UpdateTemplateRequest.h.

◆ SetVersionDescription() [3/3]

void Aws::QuickSight::Model::UpdateTemplateRequest::SetVersionDescription ( const char *  value)
inline

A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.

Definition at line 261 of file UpdateTemplateRequest.h.

◆ SourceEntityHasBeenSet()

bool Aws::QuickSight::Model::UpdateTemplateRequest::SourceEntityHasBeenSet ( ) const
inline

The entity that you are using as a source when you update the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.

Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Definition at line 156 of file UpdateTemplateRequest.h.

◆ TemplateIdHasBeenSet()

bool Aws::QuickSight::Model::UpdateTemplateRequest::TemplateIdHasBeenSet ( ) const
inline

The ID for the template.

Definition at line 93 of file UpdateTemplateRequest.h.

◆ VersionDescriptionHasBeenSet()

bool Aws::QuickSight::Model::UpdateTemplateRequest::VersionDescriptionHasBeenSet ( ) const
inline

A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.

Definition at line 237 of file UpdateTemplateRequest.h.

◆ WithAwsAccountId() [1/3]

UpdateTemplateRequest& Aws::QuickSight::Model::UpdateTemplateRequest::WithAwsAccountId ( const Aws::String value)
inline

The ID of the AWS account that contains the template that you're updating.

Definition at line 70 of file UpdateTemplateRequest.h.

◆ WithAwsAccountId() [2/3]

UpdateTemplateRequest& Aws::QuickSight::Model::UpdateTemplateRequest::WithAwsAccountId ( Aws::String &&  value)
inline

The ID of the AWS account that contains the template that you're updating.

Definition at line 76 of file UpdateTemplateRequest.h.

◆ WithAwsAccountId() [3/3]

UpdateTemplateRequest& Aws::QuickSight::Model::UpdateTemplateRequest::WithAwsAccountId ( const char *  value)
inline

The ID of the AWS account that contains the template that you're updating.

Definition at line 82 of file UpdateTemplateRequest.h.

◆ WithName() [1/3]

UpdateTemplateRequest& Aws::QuickSight::Model::UpdateTemplateRequest::WithName ( const Aws::String value)
inline

The name for the template.

Definition at line 316 of file UpdateTemplateRequest.h.

◆ WithName() [2/3]

UpdateTemplateRequest& Aws::QuickSight::Model::UpdateTemplateRequest::WithName ( Aws::String &&  value)
inline

The name for the template.

Definition at line 321 of file UpdateTemplateRequest.h.

◆ WithName() [3/3]

UpdateTemplateRequest& Aws::QuickSight::Model::UpdateTemplateRequest::WithName ( const char *  value)
inline

The name for the template.

Definition at line 326 of file UpdateTemplateRequest.h.

◆ WithSourceEntity() [1/2]

UpdateTemplateRequest& Aws::QuickSight::Model::UpdateTemplateRequest::WithSourceEntity ( const TemplateSourceEntity value)
inline

The entity that you are using as a source when you update the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.

Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Definition at line 204 of file UpdateTemplateRequest.h.

◆ WithSourceEntity() [2/2]

UpdateTemplateRequest& Aws::QuickSight::Model::UpdateTemplateRequest::WithSourceEntity ( TemplateSourceEntity &&  value)
inline

The entity that you are using as a source when you update the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.

Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Definition at line 220 of file UpdateTemplateRequest.h.

◆ WithTemplateId() [1/3]

UpdateTemplateRequest& Aws::QuickSight::Model::UpdateTemplateRequest::WithTemplateId ( const Aws::String value)
inline

The ID for the template.

Definition at line 113 of file UpdateTemplateRequest.h.

◆ WithTemplateId() [2/3]

UpdateTemplateRequest& Aws::QuickSight::Model::UpdateTemplateRequest::WithTemplateId ( Aws::String &&  value)
inline

The ID for the template.

Definition at line 118 of file UpdateTemplateRequest.h.

◆ WithTemplateId() [3/3]

UpdateTemplateRequest& Aws::QuickSight::Model::UpdateTemplateRequest::WithTemplateId ( const char *  value)
inline

The ID for the template.

Definition at line 123 of file UpdateTemplateRequest.h.

◆ WithVersionDescription() [1/3]

UpdateTemplateRequest& Aws::QuickSight::Model::UpdateTemplateRequest::WithVersionDescription ( const Aws::String value)
inline

A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.

Definition at line 269 of file UpdateTemplateRequest.h.

◆ WithVersionDescription() [2/3]

UpdateTemplateRequest& Aws::QuickSight::Model::UpdateTemplateRequest::WithVersionDescription ( Aws::String &&  value)
inline

A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.

Definition at line 277 of file UpdateTemplateRequest.h.

◆ WithVersionDescription() [3/3]

UpdateTemplateRequest& Aws::QuickSight::Model::UpdateTemplateRequest::WithVersionDescription ( const char *  value)
inline

A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.

Definition at line 285 of file UpdateTemplateRequest.h.


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