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

#include <UpdatePushTemplateRequest.h>

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

Public Member Functions

 UpdatePushTemplateRequest ()
 
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)
 
UpdatePushTemplateRequestWithCreateNewVersion (bool value)
 
const PushNotificationTemplateRequestGetPushNotificationTemplateRequest () const
 
bool PushNotificationTemplateRequestHasBeenSet () const
 
void SetPushNotificationTemplateRequest (const PushNotificationTemplateRequest &value)
 
void SetPushNotificationTemplateRequest (PushNotificationTemplateRequest &&value)
 
UpdatePushTemplateRequestWithPushNotificationTemplateRequest (const PushNotificationTemplateRequest &value)
 
UpdatePushTemplateRequestWithPushNotificationTemplateRequest (PushNotificationTemplateRequest &&value)
 
const Aws::StringGetTemplateName () const
 
bool TemplateNameHasBeenSet () const
 
void SetTemplateName (const Aws::String &value)
 
void SetTemplateName (Aws::String &&value)
 
void SetTemplateName (const char *value)
 
UpdatePushTemplateRequestWithTemplateName (const Aws::String &value)
 
UpdatePushTemplateRequestWithTemplateName (Aws::String &&value)
 
UpdatePushTemplateRequestWithTemplateName (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)
 
UpdatePushTemplateRequestWithVersion (const Aws::String &value)
 
UpdatePushTemplateRequestWithVersion (Aws::String &&value)
 
UpdatePushTemplateRequestWithVersion (const char *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 UpdatePushTemplateRequest.h.

Constructor & Destructor Documentation

◆ UpdatePushTemplateRequest()

Aws::Pinpoint::Model::UpdatePushTemplateRequest::UpdatePushTemplateRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::Pinpoint::Model::UpdatePushTemplateRequest::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::UpdatePushTemplateRequest::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 UpdatePushTemplateRequest.h.

◆ GetCreateNewVersion()

bool Aws::Pinpoint::Model::UpdatePushTemplateRequest::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 UpdatePushTemplateRequest.h.

◆ GetPushNotificationTemplateRequest()

const PushNotificationTemplateRequest& Aws::Pinpoint::Model::UpdatePushTemplateRequest::GetPushNotificationTemplateRequest ( ) const
inline

Definition at line 88 of file UpdatePushTemplateRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file UpdatePushTemplateRequest.h.

◆ GetTemplateName()

const Aws::String& Aws::Pinpoint::Model::UpdatePushTemplateRequest::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 112 of file UpdatePushTemplateRequest.h.

◆ GetVersion()

const Aws::String& Aws::Pinpoint::Model::UpdatePushTemplateRequest::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 188 of file UpdatePushTemplateRequest.h.

◆ PushNotificationTemplateRequestHasBeenSet()

bool Aws::Pinpoint::Model::UpdatePushTemplateRequest::PushNotificationTemplateRequestHasBeenSet ( ) const
inline

Definition at line 91 of file UpdatePushTemplateRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCreateNewVersion()

void Aws::Pinpoint::Model::UpdatePushTemplateRequest::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 UpdatePushTemplateRequest.h.

◆ SetPushNotificationTemplateRequest() [1/2]

void Aws::Pinpoint::Model::UpdatePushTemplateRequest::SetPushNotificationTemplateRequest ( const PushNotificationTemplateRequest value)
inline

Definition at line 94 of file UpdatePushTemplateRequest.h.

◆ SetPushNotificationTemplateRequest() [2/2]

void Aws::Pinpoint::Model::UpdatePushTemplateRequest::SetPushNotificationTemplateRequest ( PushNotificationTemplateRequest &&  value)
inline

Definition at line 97 of file UpdatePushTemplateRequest.h.

◆ SetTemplateName() [1/3]

void Aws::Pinpoint::Model::UpdatePushTemplateRequest::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 128 of file UpdatePushTemplateRequest.h.

◆ SetTemplateName() [2/3]

void Aws::Pinpoint::Model::UpdatePushTemplateRequest::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 136 of file UpdatePushTemplateRequest.h.

◆ SetTemplateName() [3/3]

void Aws::Pinpoint::Model::UpdatePushTemplateRequest::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 144 of file UpdatePushTemplateRequest.h.

◆ SetVersion() [1/3]

void Aws::Pinpoint::Model::UpdatePushTemplateRequest::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 226 of file UpdatePushTemplateRequest.h.

◆ SetVersion() [2/3]

void Aws::Pinpoint::Model::UpdatePushTemplateRequest::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 245 of file UpdatePushTemplateRequest.h.

◆ SetVersion() [3/3]

void Aws::Pinpoint::Model::UpdatePushTemplateRequest::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 264 of file UpdatePushTemplateRequest.h.

◆ TemplateNameHasBeenSet()

bool Aws::Pinpoint::Model::UpdatePushTemplateRequest::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 120 of file UpdatePushTemplateRequest.h.

◆ VersionHasBeenSet()

bool Aws::Pinpoint::Model::UpdatePushTemplateRequest::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 207 of file UpdatePushTemplateRequest.h.

◆ WithCreateNewVersion()

UpdatePushTemplateRequest& Aws::Pinpoint::Model::UpdatePushTemplateRequest::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 UpdatePushTemplateRequest.h.

◆ WithPushNotificationTemplateRequest() [1/2]

UpdatePushTemplateRequest& Aws::Pinpoint::Model::UpdatePushTemplateRequest::WithPushNotificationTemplateRequest ( const PushNotificationTemplateRequest value)
inline

Definition at line 100 of file UpdatePushTemplateRequest.h.

◆ WithPushNotificationTemplateRequest() [2/2]

UpdatePushTemplateRequest& Aws::Pinpoint::Model::UpdatePushTemplateRequest::WithPushNotificationTemplateRequest ( PushNotificationTemplateRequest &&  value)
inline

Definition at line 103 of file UpdatePushTemplateRequest.h.

◆ WithTemplateName() [1/3]

UpdatePushTemplateRequest& Aws::Pinpoint::Model::UpdatePushTemplateRequest::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 152 of file UpdatePushTemplateRequest.h.

◆ WithTemplateName() [2/3]

UpdatePushTemplateRequest& Aws::Pinpoint::Model::UpdatePushTemplateRequest::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 160 of file UpdatePushTemplateRequest.h.

◆ WithTemplateName() [3/3]

UpdatePushTemplateRequest& Aws::Pinpoint::Model::UpdatePushTemplateRequest::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 168 of file UpdatePushTemplateRequest.h.

◆ WithVersion() [1/3]

UpdatePushTemplateRequest& Aws::Pinpoint::Model::UpdatePushTemplateRequest::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 283 of file UpdatePushTemplateRequest.h.

◆ WithVersion() [2/3]

UpdatePushTemplateRequest& Aws::Pinpoint::Model::UpdatePushTemplateRequest::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 302 of file UpdatePushTemplateRequest.h.

◆ WithVersion() [3/3]

UpdatePushTemplateRequest& Aws::Pinpoint::Model::UpdatePushTemplateRequest::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 321 of file UpdatePushTemplateRequest.h.


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