AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | List of all members
Aws::SESV2::Model::ListContactsRequest Class Reference

#include <ListContactsRequest.h>

+ Inheritance diagram for Aws::SESV2::Model::ListContactsRequest:

Public Member Functions

 ListContactsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
const Aws::StringGetContactListName () const
 
bool ContactListNameHasBeenSet () const
 
void SetContactListName (const Aws::String &value)
 
void SetContactListName (Aws::String &&value)
 
void SetContactListName (const char *value)
 
ListContactsRequestWithContactListName (const Aws::String &value)
 
ListContactsRequestWithContactListName (Aws::String &&value)
 
ListContactsRequestWithContactListName (const char *value)
 
const ListContactsFilterGetFilter () const
 
bool FilterHasBeenSet () const
 
void SetFilter (const ListContactsFilter &value)
 
void SetFilter (ListContactsFilter &&value)
 
ListContactsRequestWithFilter (const ListContactsFilter &value)
 
ListContactsRequestWithFilter (ListContactsFilter &&value)
 
int GetPageSize () const
 
bool PageSizeHasBeenSet () const
 
void SetPageSize (int value)
 
ListContactsRequestWithPageSize (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListContactsRequestWithNextToken (const Aws::String &value)
 
ListContactsRequestWithNextToken (Aws::String &&value)
 
ListContactsRequestWithNextToken (const char *value)
 
- Public Member Functions inherited from Aws::SESV2::SESV2Request
virtual ~SESV2Request ()
 
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::SESV2::SESV2Request
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 ListContactsRequest.h.

Constructor & Destructor Documentation

◆ ListContactsRequest()

Aws::SESV2::Model::ListContactsRequest::ListContactsRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::SESV2::Model::ListContactsRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ ContactListNameHasBeenSet()

bool Aws::SESV2::Model::ListContactsRequest::ContactListNameHasBeenSet ( ) const
inline

The name of the contact list.

Definition at line 50 of file ListContactsRequest.h.

◆ FilterHasBeenSet()

bool Aws::SESV2::Model::ListContactsRequest::FilterHasBeenSet ( ) const
inline

A filter that can be applied to a list of contacts.

Definition at line 91 of file ListContactsRequest.h.

◆ GetContactListName()

const Aws::String& Aws::SESV2::Model::ListContactsRequest::GetContactListName ( ) const
inline

The name of the contact list.

Definition at line 45 of file ListContactsRequest.h.

◆ GetFilter()

const ListContactsFilter& Aws::SESV2::Model::ListContactsRequest::GetFilter ( ) const
inline

A filter that can be applied to a list of contacts.

Definition at line 86 of file ListContactsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::SESV2::Model::ListContactsRequest::GetNextToken ( ) const
inline

A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

Definition at line 161 of file ListContactsRequest.h.

◆ GetPageSize()

int Aws::SESV2::Model::ListContactsRequest::GetPageSize ( ) const
inline

The number of contacts that may be returned at once, which is dependent on if there are more or less contacts than the value of the PageSize. Use this parameter to paginate results. If additional contacts exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional contacts.

Definition at line 122 of file ListContactsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::SESV2::Model::ListContactsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file ListContactsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::SESV2::Model::ListContactsRequest::NextTokenHasBeenSet ( ) const
inline

A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

Definition at line 169 of file ListContactsRequest.h.

◆ PageSizeHasBeenSet()

bool Aws::SESV2::Model::ListContactsRequest::PageSizeHasBeenSet ( ) const
inline

The number of contacts that may be returned at once, which is dependent on if there are more or less contacts than the value of the PageSize. Use this parameter to paginate results. If additional contacts exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional contacts.

Definition at line 132 of file ListContactsRequest.h.

◆ SerializePayload()

Aws::String Aws::SESV2::Model::ListContactsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetContactListName() [1/3]

void Aws::SESV2::Model::ListContactsRequest::SetContactListName ( Aws::String &&  value)
inline

The name of the contact list.

Definition at line 60 of file ListContactsRequest.h.

◆ SetContactListName() [2/3]

void Aws::SESV2::Model::ListContactsRequest::SetContactListName ( const Aws::String value)
inline

The name of the contact list.

Definition at line 55 of file ListContactsRequest.h.

◆ SetContactListName() [3/3]

void Aws::SESV2::Model::ListContactsRequest::SetContactListName ( const char *  value)
inline

The name of the contact list.

Definition at line 65 of file ListContactsRequest.h.

◆ SetFilter() [1/2]

void Aws::SESV2::Model::ListContactsRequest::SetFilter ( const ListContactsFilter value)
inline

A filter that can be applied to a list of contacts.

Definition at line 96 of file ListContactsRequest.h.

◆ SetFilter() [2/2]

void Aws::SESV2::Model::ListContactsRequest::SetFilter ( ListContactsFilter &&  value)
inline

A filter that can be applied to a list of contacts.

Definition at line 101 of file ListContactsRequest.h.

◆ SetNextToken() [1/3]

void Aws::SESV2::Model::ListContactsRequest::SetNextToken ( Aws::String &&  value)
inline

A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

Definition at line 185 of file ListContactsRequest.h.

◆ SetNextToken() [2/3]

void Aws::SESV2::Model::ListContactsRequest::SetNextToken ( const Aws::String value)
inline

A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

Definition at line 177 of file ListContactsRequest.h.

◆ SetNextToken() [3/3]

void Aws::SESV2::Model::ListContactsRequest::SetNextToken ( const char *  value)
inline

A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

Definition at line 193 of file ListContactsRequest.h.

◆ SetPageSize()

void Aws::SESV2::Model::ListContactsRequest::SetPageSize ( int  value)
inline

The number of contacts that may be returned at once, which is dependent on if there are more or less contacts than the value of the PageSize. Use this parameter to paginate results. If additional contacts exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional contacts.

Definition at line 142 of file ListContactsRequest.h.

◆ WithContactListName() [1/3]

ListContactsRequest& Aws::SESV2::Model::ListContactsRequest::WithContactListName ( Aws::String &&  value)
inline

The name of the contact list.

Definition at line 75 of file ListContactsRequest.h.

◆ WithContactListName() [2/3]

ListContactsRequest& Aws::SESV2::Model::ListContactsRequest::WithContactListName ( const Aws::String value)
inline

The name of the contact list.

Definition at line 70 of file ListContactsRequest.h.

◆ WithContactListName() [3/3]

ListContactsRequest& Aws::SESV2::Model::ListContactsRequest::WithContactListName ( const char *  value)
inline

The name of the contact list.

Definition at line 80 of file ListContactsRequest.h.

◆ WithFilter() [1/2]

ListContactsRequest& Aws::SESV2::Model::ListContactsRequest::WithFilter ( const ListContactsFilter value)
inline

A filter that can be applied to a list of contacts.

Definition at line 106 of file ListContactsRequest.h.

◆ WithFilter() [2/2]

ListContactsRequest& Aws::SESV2::Model::ListContactsRequest::WithFilter ( ListContactsFilter &&  value)
inline

A filter that can be applied to a list of contacts.

Definition at line 111 of file ListContactsRequest.h.

◆ WithNextToken() [1/3]

ListContactsRequest& Aws::SESV2::Model::ListContactsRequest::WithNextToken ( Aws::String &&  value)
inline

A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

Definition at line 209 of file ListContactsRequest.h.

◆ WithNextToken() [2/3]

ListContactsRequest& Aws::SESV2::Model::ListContactsRequest::WithNextToken ( const Aws::String value)
inline

A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

Definition at line 201 of file ListContactsRequest.h.

◆ WithNextToken() [3/3]

ListContactsRequest& Aws::SESV2::Model::ListContactsRequest::WithNextToken ( const char *  value)
inline

A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

Definition at line 217 of file ListContactsRequest.h.

◆ WithPageSize()

ListContactsRequest& Aws::SESV2::Model::ListContactsRequest::WithPageSize ( int  value)
inline

The number of contacts that may be returned at once, which is dependent on if there are more or less contacts than the value of the PageSize. Use this parameter to paginate results. If additional contacts exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional contacts.

Definition at line 152 of file ListContactsRequest.h.


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