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

#include <ListTemplatesRequest.h>

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

Public Member Functions

 ListTemplatesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListTemplatesRequestWithNextToken (const Aws::String &value)
 
ListTemplatesRequestWithNextToken (Aws::String &&value)
 
ListTemplatesRequestWithNextToken (const char *value)
 
const Aws::StringGetPageSize () const
 
bool PageSizeHasBeenSet () const
 
void SetPageSize (const Aws::String &value)
 
void SetPageSize (Aws::String &&value)
 
void SetPageSize (const char *value)
 
ListTemplatesRequestWithPageSize (const Aws::String &value)
 
ListTemplatesRequestWithPageSize (Aws::String &&value)
 
ListTemplatesRequestWithPageSize (const char *value)
 
const Aws::StringGetPrefix () const
 
bool PrefixHasBeenSet () const
 
void SetPrefix (const Aws::String &value)
 
void SetPrefix (Aws::String &&value)
 
void SetPrefix (const char *value)
 
ListTemplatesRequestWithPrefix (const Aws::String &value)
 
ListTemplatesRequestWithPrefix (Aws::String &&value)
 
ListTemplatesRequestWithPrefix (const char *value)
 
const Aws::StringGetTemplateType () const
 
bool TemplateTypeHasBeenSet () const
 
void SetTemplateType (const Aws::String &value)
 
void SetTemplateType (Aws::String &&value)
 
void SetTemplateType (const char *value)
 
ListTemplatesRequestWithTemplateType (const Aws::String &value)
 
ListTemplatesRequestWithTemplateType (Aws::String &&value)
 
ListTemplatesRequestWithTemplateType (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 25 of file ListTemplatesRequest.h.

Constructor & Destructor Documentation

◆ ListTemplatesRequest()

Aws::Pinpoint::Model::ListTemplatesRequest::ListTemplatesRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

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

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetNextToken()

const Aws::String& Aws::Pinpoint::Model::ListTemplatesRequest::GetNextToken ( ) const
inline

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

Definition at line 46 of file ListTemplatesRequest.h.

◆ GetPageSize()

const Aws::String& Aws::Pinpoint::Model::ListTemplatesRequest::GetPageSize ( ) const
inline

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

Definition at line 103 of file ListTemplatesRequest.h.

◆ GetPrefix()

const Aws::String& Aws::Pinpoint::Model::ListTemplatesRequest::GetPrefix ( ) const
inline

The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.

Definition at line 160 of file ListTemplatesRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file ListTemplatesRequest.h.

◆ GetTemplateType()

const Aws::String& Aws::Pinpoint::Model::ListTemplatesRequest::GetTemplateType ( ) const
inline

The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.

Definition at line 217 of file ListTemplatesRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::Pinpoint::Model::ListTemplatesRequest::NextTokenHasBeenSet ( ) const
inline

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

Definition at line 53 of file ListTemplatesRequest.h.

◆ PageSizeHasBeenSet()

bool Aws::Pinpoint::Model::ListTemplatesRequest::PageSizeHasBeenSet ( ) const
inline

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

Definition at line 110 of file ListTemplatesRequest.h.

◆ PrefixHasBeenSet()

bool Aws::Pinpoint::Model::ListTemplatesRequest::PrefixHasBeenSet ( ) const
inline

The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.

Definition at line 167 of file ListTemplatesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetNextToken() [1/3]

void Aws::Pinpoint::Model::ListTemplatesRequest::SetNextToken ( const Aws::String value)
inline

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

Definition at line 60 of file ListTemplatesRequest.h.

◆ SetNextToken() [2/3]

void Aws::Pinpoint::Model::ListTemplatesRequest::SetNextToken ( Aws::String &&  value)
inline

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

Definition at line 67 of file ListTemplatesRequest.h.

◆ SetNextToken() [3/3]

void Aws::Pinpoint::Model::ListTemplatesRequest::SetNextToken ( const char *  value)
inline

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

Definition at line 74 of file ListTemplatesRequest.h.

◆ SetPageSize() [1/3]

void Aws::Pinpoint::Model::ListTemplatesRequest::SetPageSize ( const Aws::String value)
inline

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

Definition at line 117 of file ListTemplatesRequest.h.

◆ SetPageSize() [2/3]

void Aws::Pinpoint::Model::ListTemplatesRequest::SetPageSize ( Aws::String &&  value)
inline

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

Definition at line 124 of file ListTemplatesRequest.h.

◆ SetPageSize() [3/3]

void Aws::Pinpoint::Model::ListTemplatesRequest::SetPageSize ( const char *  value)
inline

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

Definition at line 131 of file ListTemplatesRequest.h.

◆ SetPrefix() [1/3]

void Aws::Pinpoint::Model::ListTemplatesRequest::SetPrefix ( const Aws::String value)
inline

The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.

Definition at line 174 of file ListTemplatesRequest.h.

◆ SetPrefix() [2/3]

void Aws::Pinpoint::Model::ListTemplatesRequest::SetPrefix ( Aws::String &&  value)
inline

The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.

Definition at line 181 of file ListTemplatesRequest.h.

◆ SetPrefix() [3/3]

void Aws::Pinpoint::Model::ListTemplatesRequest::SetPrefix ( const char *  value)
inline

The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.

Definition at line 188 of file ListTemplatesRequest.h.

◆ SetTemplateType() [1/3]

void Aws::Pinpoint::Model::ListTemplatesRequest::SetTemplateType ( const Aws::String value)
inline

The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.

Definition at line 231 of file ListTemplatesRequest.h.

◆ SetTemplateType() [2/3]

void Aws::Pinpoint::Model::ListTemplatesRequest::SetTemplateType ( Aws::String &&  value)
inline

The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.

Definition at line 238 of file ListTemplatesRequest.h.

◆ SetTemplateType() [3/3]

void Aws::Pinpoint::Model::ListTemplatesRequest::SetTemplateType ( const char *  value)
inline

The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.

Definition at line 245 of file ListTemplatesRequest.h.

◆ TemplateTypeHasBeenSet()

bool Aws::Pinpoint::Model::ListTemplatesRequest::TemplateTypeHasBeenSet ( ) const
inline

The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.

Definition at line 224 of file ListTemplatesRequest.h.

◆ WithNextToken() [1/3]

ListTemplatesRequest& Aws::Pinpoint::Model::ListTemplatesRequest::WithNextToken ( const Aws::String value)
inline

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

Definition at line 81 of file ListTemplatesRequest.h.

◆ WithNextToken() [2/3]

ListTemplatesRequest& Aws::Pinpoint::Model::ListTemplatesRequest::WithNextToken ( Aws::String &&  value)
inline

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

Definition at line 88 of file ListTemplatesRequest.h.

◆ WithNextToken() [3/3]

ListTemplatesRequest& Aws::Pinpoint::Model::ListTemplatesRequest::WithNextToken ( const char *  value)
inline

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

Definition at line 95 of file ListTemplatesRequest.h.

◆ WithPageSize() [1/3]

ListTemplatesRequest& Aws::Pinpoint::Model::ListTemplatesRequest::WithPageSize ( const Aws::String value)
inline

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

Definition at line 138 of file ListTemplatesRequest.h.

◆ WithPageSize() [2/3]

ListTemplatesRequest& Aws::Pinpoint::Model::ListTemplatesRequest::WithPageSize ( Aws::String &&  value)
inline

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

Definition at line 145 of file ListTemplatesRequest.h.

◆ WithPageSize() [3/3]

ListTemplatesRequest& Aws::Pinpoint::Model::ListTemplatesRequest::WithPageSize ( const char *  value)
inline

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

Definition at line 152 of file ListTemplatesRequest.h.

◆ WithPrefix() [1/3]

ListTemplatesRequest& Aws::Pinpoint::Model::ListTemplatesRequest::WithPrefix ( const Aws::String value)
inline

The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.

Definition at line 195 of file ListTemplatesRequest.h.

◆ WithPrefix() [2/3]

ListTemplatesRequest& Aws::Pinpoint::Model::ListTemplatesRequest::WithPrefix ( Aws::String &&  value)
inline

The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.

Definition at line 202 of file ListTemplatesRequest.h.

◆ WithPrefix() [3/3]

ListTemplatesRequest& Aws::Pinpoint::Model::ListTemplatesRequest::WithPrefix ( const char *  value)
inline

The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.

Definition at line 209 of file ListTemplatesRequest.h.

◆ WithTemplateType() [1/3]

ListTemplatesRequest& Aws::Pinpoint::Model::ListTemplatesRequest::WithTemplateType ( const Aws::String value)
inline

The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.

Definition at line 252 of file ListTemplatesRequest.h.

◆ WithTemplateType() [2/3]

ListTemplatesRequest& Aws::Pinpoint::Model::ListTemplatesRequest::WithTemplateType ( Aws::String &&  value)
inline

The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.

Definition at line 259 of file ListTemplatesRequest.h.

◆ WithTemplateType() [3/3]

ListTemplatesRequest& Aws::Pinpoint::Model::ListTemplatesRequest::WithTemplateType ( const char *  value)
inline

The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.

Definition at line 266 of file ListTemplatesRequest.h.


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