AWS SDK for C++  1.8.59
AWS SDK for C++
Public Member Functions | List of all members
Aws::Pinpoint::Model::UpdateVoiceTemplateRequest Class Reference

#include <UpdateVoiceTemplateRequest.h>

+ Inheritance diagram for Aws::Pinpoint::Model::UpdateVoiceTemplateRequest:

Public Member Functions

 UpdateVoiceTemplateRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
bool GetCreateNewVersion () const
 
bool CreateNewVersionHasBeenSet () const
 
void SetCreateNewVersion (bool value)
 
UpdateVoiceTemplateRequestWithCreateNewVersion (bool value)
 
const Aws::StringGetTemplateName () const
 
bool TemplateNameHasBeenSet () const
 
void SetTemplateName (const Aws::String &value)
 
void SetTemplateName (Aws::String &&value)
 
void SetTemplateName (const char *value)
 
UpdateVoiceTemplateRequestWithTemplateName (const Aws::String &value)
 
UpdateVoiceTemplateRequestWithTemplateName (Aws::String &&value)
 
UpdateVoiceTemplateRequestWithTemplateName (const char *value)
 
const Aws::StringGetVersion () const
 
bool VersionHasBeenSet () const
 
void SetVersion (const Aws::String &value)
 
void SetVersion (Aws::String &&value)
 
void SetVersion (const char *value)
 
UpdateVoiceTemplateRequestWithVersion (const Aws::String &value)
 
UpdateVoiceTemplateRequestWithVersion (Aws::String &&value)
 
UpdateVoiceTemplateRequestWithVersion (const char *value)
 
const VoiceTemplateRequestGetVoiceTemplateRequest () const
 
bool VoiceTemplateRequestHasBeenSet () const
 
void SetVoiceTemplateRequest (const VoiceTemplateRequest &value)
 
void SetVoiceTemplateRequest (VoiceTemplateRequest &&value)
 
UpdateVoiceTemplateRequestWithVoiceTemplateRequest (const VoiceTemplateRequest &value)
 
UpdateVoiceTemplateRequestWithVoiceTemplateRequest (VoiceTemplateRequest &&value)
 
- Public Member Functions inherited from Aws::Pinpoint::PinpointRequest
virtual ~PinpointRequest ()
 
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 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::Pinpoint::PinpointRequest
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 26 of file UpdateVoiceTemplateRequest.h.

Constructor & Destructor Documentation

◆ UpdateVoiceTemplateRequest()

Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::UpdateVoiceTemplateRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

◆ CreateNewVersionHasBeenSet()

bool Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::CreateNewVersionHasBeenSet ( ) const
inline

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

Definition at line 62 of file UpdateVoiceTemplateRequest.h.

◆ GetCreateNewVersion()

bool Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::GetCreateNewVersion ( ) const
inline

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

Definition at line 51 of file UpdateVoiceTemplateRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file UpdateVoiceTemplateRequest.h.

◆ GetTemplateName()

const Aws::String& Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::GetTemplateName ( ) const
inline

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Definition at line 93 of file UpdateVoiceTemplateRequest.h.

◆ GetVersion()

const Aws::String& Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::GetVersion ( ) const
inline

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

  • For a get operation, retrieves information about the active version of the template.

  • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

  • For a delete operation, deletes the template, including all versions of the template.

Definition at line 169 of file UpdateVoiceTemplateRequest.h.

◆ GetVoiceTemplateRequest()

const VoiceTemplateRequest& Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::GetVoiceTemplateRequest ( ) const
inline

Definition at line 306 of file UpdateVoiceTemplateRequest.h.

◆ SerializePayload()

Aws::String Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCreateNewVersion()

void Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::SetCreateNewVersion ( bool  value)
inline

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

Definition at line 73 of file UpdateVoiceTemplateRequest.h.

◆ SetTemplateName() [1/3]

void Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::SetTemplateName ( const Aws::String value)
inline

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Definition at line 109 of file UpdateVoiceTemplateRequest.h.

◆ SetTemplateName() [2/3]

void Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::SetTemplateName ( Aws::String &&  value)
inline

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Definition at line 117 of file UpdateVoiceTemplateRequest.h.

◆ SetTemplateName() [3/3]

void Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::SetTemplateName ( const char *  value)
inline

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Definition at line 125 of file UpdateVoiceTemplateRequest.h.

◆ SetVersion() [1/3]

void Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::SetVersion ( const Aws::String value)
inline

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

  • For a get operation, retrieves information about the active version of the template.

  • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

  • For a delete operation, deletes the template, including all versions of the template.

Definition at line 207 of file UpdateVoiceTemplateRequest.h.

◆ SetVersion() [2/3]

void Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::SetVersion ( Aws::String &&  value)
inline

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

  • For a get operation, retrieves information about the active version of the template.

  • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

  • For a delete operation, deletes the template, including all versions of the template.

Definition at line 226 of file UpdateVoiceTemplateRequest.h.

◆ SetVersion() [3/3]

void Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::SetVersion ( const char *  value)
inline

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

  • For a get operation, retrieves information about the active version of the template.

  • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

  • For a delete operation, deletes the template, including all versions of the template.

Definition at line 245 of file UpdateVoiceTemplateRequest.h.

◆ SetVoiceTemplateRequest() [1/2]

void Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::SetVoiceTemplateRequest ( const VoiceTemplateRequest value)
inline

Definition at line 312 of file UpdateVoiceTemplateRequest.h.

◆ SetVoiceTemplateRequest() [2/2]

void Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::SetVoiceTemplateRequest ( VoiceTemplateRequest &&  value)
inline

Definition at line 315 of file UpdateVoiceTemplateRequest.h.

◆ TemplateNameHasBeenSet()

bool Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::TemplateNameHasBeenSet ( ) const
inline

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Definition at line 101 of file UpdateVoiceTemplateRequest.h.

◆ VersionHasBeenSet()

bool Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::VersionHasBeenSet ( ) const
inline

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

  • For a get operation, retrieves information about the active version of the template.

  • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

  • For a delete operation, deletes the template, including all versions of the template.

Definition at line 188 of file UpdateVoiceTemplateRequest.h.

◆ VoiceTemplateRequestHasBeenSet()

bool Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::VoiceTemplateRequestHasBeenSet ( ) const
inline

Definition at line 309 of file UpdateVoiceTemplateRequest.h.

◆ WithCreateNewVersion()

UpdateVoiceTemplateRequest& Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::WithCreateNewVersion ( bool  value)
inline

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

Definition at line 84 of file UpdateVoiceTemplateRequest.h.

◆ WithTemplateName() [1/3]

UpdateVoiceTemplateRequest& Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::WithTemplateName ( const Aws::String value)
inline

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Definition at line 133 of file UpdateVoiceTemplateRequest.h.

◆ WithTemplateName() [2/3]

UpdateVoiceTemplateRequest& Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::WithTemplateName ( Aws::String &&  value)
inline

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Definition at line 141 of file UpdateVoiceTemplateRequest.h.

◆ WithTemplateName() [3/3]

UpdateVoiceTemplateRequest& Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::WithTemplateName ( const char *  value)
inline

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Definition at line 149 of file UpdateVoiceTemplateRequest.h.

◆ WithVersion() [1/3]

UpdateVoiceTemplateRequest& Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::WithVersion ( const Aws::String value)
inline

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

  • For a get operation, retrieves information about the active version of the template.

  • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

  • For a delete operation, deletes the template, including all versions of the template.

Definition at line 264 of file UpdateVoiceTemplateRequest.h.

◆ WithVersion() [2/3]

UpdateVoiceTemplateRequest& Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::WithVersion ( Aws::String &&  value)
inline

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

  • For a get operation, retrieves information about the active version of the template.

  • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

  • For a delete operation, deletes the template, including all versions of the template.

Definition at line 283 of file UpdateVoiceTemplateRequest.h.

◆ WithVersion() [3/3]

UpdateVoiceTemplateRequest& Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::WithVersion ( const char *  value)
inline

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

  • For a get operation, retrieves information about the active version of the template.

  • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

  • For a delete operation, deletes the template, including all versions of the template.

Definition at line 302 of file UpdateVoiceTemplateRequest.h.

◆ WithVoiceTemplateRequest() [1/2]

UpdateVoiceTemplateRequest& Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::WithVoiceTemplateRequest ( const VoiceTemplateRequest value)
inline

Definition at line 318 of file UpdateVoiceTemplateRequest.h.

◆ WithVoiceTemplateRequest() [2/2]

UpdateVoiceTemplateRequest& Aws::Pinpoint::Model::UpdateVoiceTemplateRequest::WithVoiceTemplateRequest ( VoiceTemplateRequest &&  value)
inline

Definition at line 321 of file UpdateVoiceTemplateRequest.h.


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