AWS SDK for C++  1.9.104
AWS SDK for C++
Public Member Functions | List of all members
Aws::CustomerProfiles::Model::SearchProfilesRequest Class Reference

#include <SearchProfilesRequest.h>

+ Inheritance diagram for Aws::CustomerProfiles::Model::SearchProfilesRequest:

Public Member Functions

 SearchProfilesRequest ()
 
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)
 
SearchProfilesRequestWithNextToken (const Aws::String &value)
 
SearchProfilesRequestWithNextToken (Aws::String &&value)
 
SearchProfilesRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
SearchProfilesRequestWithMaxResults (int value)
 
const Aws::StringGetDomainName () const
 
bool DomainNameHasBeenSet () const
 
void SetDomainName (const Aws::String &value)
 
void SetDomainName (Aws::String &&value)
 
void SetDomainName (const char *value)
 
SearchProfilesRequestWithDomainName (const Aws::String &value)
 
SearchProfilesRequestWithDomainName (Aws::String &&value)
 
SearchProfilesRequestWithDomainName (const char *value)
 
const Aws::StringGetKeyName () const
 
bool KeyNameHasBeenSet () const
 
void SetKeyName (const Aws::String &value)
 
void SetKeyName (Aws::String &&value)
 
void SetKeyName (const char *value)
 
SearchProfilesRequestWithKeyName (const Aws::String &value)
 
SearchProfilesRequestWithKeyName (Aws::String &&value)
 
SearchProfilesRequestWithKeyName (const char *value)
 
const Aws::Vector< Aws::String > & GetValues () const
 
bool ValuesHasBeenSet () const
 
void SetValues (const Aws::Vector< Aws::String > &value)
 
void SetValues (Aws::Vector< Aws::String > &&value)
 
SearchProfilesRequestWithValues (const Aws::Vector< Aws::String > &value)
 
SearchProfilesRequestWithValues (Aws::Vector< Aws::String > &&value)
 
SearchProfilesRequestAddValues (const Aws::String &value)
 
SearchProfilesRequestAddValues (Aws::String &&value)
 
SearchProfilesRequestAddValues (const char *value)
 
- Public Member Functions inherited from Aws::CustomerProfiles::CustomerProfilesRequest
virtual ~CustomerProfilesRequest ()
 
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::CustomerProfiles::CustomerProfilesRequest
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 SearchProfilesRequest.h.

Constructor & Destructor Documentation

◆ SearchProfilesRequest()

Aws::CustomerProfiles::Model::SearchProfilesRequest::SearchProfilesRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::CustomerProfiles::Model::SearchProfilesRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ AddValues() [1/3]

SearchProfilesRequest& Aws::CustomerProfiles::Model::SearchProfilesRequest::AddValues ( Aws::String &&  value)
inline

A list of key values.

Definition at line 248 of file SearchProfilesRequest.h.

◆ AddValues() [2/3]

SearchProfilesRequest& Aws::CustomerProfiles::Model::SearchProfilesRequest::AddValues ( const Aws::String value)
inline

A list of key values.

Definition at line 243 of file SearchProfilesRequest.h.

◆ AddValues() [3/3]

SearchProfilesRequest& Aws::CustomerProfiles::Model::SearchProfilesRequest::AddValues ( const char *  value)
inline

A list of key values.

Definition at line 253 of file SearchProfilesRequest.h.

◆ DomainNameHasBeenSet()

bool Aws::CustomerProfiles::Model::SearchProfilesRequest::DomainNameHasBeenSet ( ) const
inline

The unique name of the domain.

Definition at line 112 of file SearchProfilesRequest.h.

◆ GetDomainName()

const Aws::String& Aws::CustomerProfiles::Model::SearchProfilesRequest::GetDomainName ( ) const
inline

The unique name of the domain.

Definition at line 107 of file SearchProfilesRequest.h.

◆ GetKeyName()

const Aws::String& Aws::CustomerProfiles::Model::SearchProfilesRequest::GetKeyName ( ) const
inline

A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.

Definition at line 151 of file SearchProfilesRequest.h.

◆ GetMaxResults()

int Aws::CustomerProfiles::Model::SearchProfilesRequest::GetMaxResults ( ) const
inline

The maximum number of objects returned per page.

Definition at line 86 of file SearchProfilesRequest.h.

◆ GetNextToken()

const Aws::String& Aws::CustomerProfiles::Model::SearchProfilesRequest::GetNextToken ( ) const
inline

The pagination token from the previous SearchProfiles API call.

Definition at line 45 of file SearchProfilesRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::CustomerProfiles::Model::SearchProfilesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file SearchProfilesRequest.h.

◆ GetValues()

const Aws::Vector<Aws::String>& Aws::CustomerProfiles::Model::SearchProfilesRequest::GetValues ( ) const
inline

A list of key values.

Definition at line 213 of file SearchProfilesRequest.h.

◆ KeyNameHasBeenSet()

bool Aws::CustomerProfiles::Model::SearchProfilesRequest::KeyNameHasBeenSet ( ) const
inline

A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.

Definition at line 159 of file SearchProfilesRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::CustomerProfiles::Model::SearchProfilesRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of objects returned per page.

Definition at line 91 of file SearchProfilesRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::CustomerProfiles::Model::SearchProfilesRequest::NextTokenHasBeenSet ( ) const
inline

The pagination token from the previous SearchProfiles API call.

Definition at line 50 of file SearchProfilesRequest.h.

◆ SerializePayload()

Aws::String Aws::CustomerProfiles::Model::SearchProfilesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDomainName() [1/3]

void Aws::CustomerProfiles::Model::SearchProfilesRequest::SetDomainName ( Aws::String &&  value)
inline

The unique name of the domain.

Definition at line 122 of file SearchProfilesRequest.h.

◆ SetDomainName() [2/3]

void Aws::CustomerProfiles::Model::SearchProfilesRequest::SetDomainName ( const Aws::String value)
inline

The unique name of the domain.

Definition at line 117 of file SearchProfilesRequest.h.

◆ SetDomainName() [3/3]

void Aws::CustomerProfiles::Model::SearchProfilesRequest::SetDomainName ( const char *  value)
inline

The unique name of the domain.

Definition at line 127 of file SearchProfilesRequest.h.

◆ SetKeyName() [1/3]

void Aws::CustomerProfiles::Model::SearchProfilesRequest::SetKeyName ( Aws::String &&  value)
inline

A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.

Definition at line 175 of file SearchProfilesRequest.h.

◆ SetKeyName() [2/3]

void Aws::CustomerProfiles::Model::SearchProfilesRequest::SetKeyName ( const Aws::String value)
inline

A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.

Definition at line 167 of file SearchProfilesRequest.h.

◆ SetKeyName() [3/3]

void Aws::CustomerProfiles::Model::SearchProfilesRequest::SetKeyName ( const char *  value)
inline

A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.

Definition at line 183 of file SearchProfilesRequest.h.

◆ SetMaxResults()

void Aws::CustomerProfiles::Model::SearchProfilesRequest::SetMaxResults ( int  value)
inline

The maximum number of objects returned per page.

Definition at line 96 of file SearchProfilesRequest.h.

◆ SetNextToken() [1/3]

void Aws::CustomerProfiles::Model::SearchProfilesRequest::SetNextToken ( Aws::String &&  value)
inline

The pagination token from the previous SearchProfiles API call.

Definition at line 60 of file SearchProfilesRequest.h.

◆ SetNextToken() [2/3]

void Aws::CustomerProfiles::Model::SearchProfilesRequest::SetNextToken ( const Aws::String value)
inline

The pagination token from the previous SearchProfiles API call.

Definition at line 55 of file SearchProfilesRequest.h.

◆ SetNextToken() [3/3]

void Aws::CustomerProfiles::Model::SearchProfilesRequest::SetNextToken ( const char *  value)
inline

The pagination token from the previous SearchProfiles API call.

Definition at line 65 of file SearchProfilesRequest.h.

◆ SetValues() [1/2]

void Aws::CustomerProfiles::Model::SearchProfilesRequest::SetValues ( Aws::Vector< Aws::String > &&  value)
inline

A list of key values.

Definition at line 228 of file SearchProfilesRequest.h.

◆ SetValues() [2/2]

void Aws::CustomerProfiles::Model::SearchProfilesRequest::SetValues ( const Aws::Vector< Aws::String > &  value)
inline

A list of key values.

Definition at line 223 of file SearchProfilesRequest.h.

◆ ValuesHasBeenSet()

bool Aws::CustomerProfiles::Model::SearchProfilesRequest::ValuesHasBeenSet ( ) const
inline

A list of key values.

Definition at line 218 of file SearchProfilesRequest.h.

◆ WithDomainName() [1/3]

SearchProfilesRequest& Aws::CustomerProfiles::Model::SearchProfilesRequest::WithDomainName ( Aws::String &&  value)
inline

The unique name of the domain.

Definition at line 137 of file SearchProfilesRequest.h.

◆ WithDomainName() [2/3]

SearchProfilesRequest& Aws::CustomerProfiles::Model::SearchProfilesRequest::WithDomainName ( const Aws::String value)
inline

The unique name of the domain.

Definition at line 132 of file SearchProfilesRequest.h.

◆ WithDomainName() [3/3]

SearchProfilesRequest& Aws::CustomerProfiles::Model::SearchProfilesRequest::WithDomainName ( const char *  value)
inline

The unique name of the domain.

Definition at line 142 of file SearchProfilesRequest.h.

◆ WithKeyName() [1/3]

SearchProfilesRequest& Aws::CustomerProfiles::Model::SearchProfilesRequest::WithKeyName ( Aws::String &&  value)
inline

A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.

Definition at line 199 of file SearchProfilesRequest.h.

◆ WithKeyName() [2/3]

SearchProfilesRequest& Aws::CustomerProfiles::Model::SearchProfilesRequest::WithKeyName ( const Aws::String value)
inline

A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.

Definition at line 191 of file SearchProfilesRequest.h.

◆ WithKeyName() [3/3]

SearchProfilesRequest& Aws::CustomerProfiles::Model::SearchProfilesRequest::WithKeyName ( const char *  value)
inline

A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.

Definition at line 207 of file SearchProfilesRequest.h.

◆ WithMaxResults()

SearchProfilesRequest& Aws::CustomerProfiles::Model::SearchProfilesRequest::WithMaxResults ( int  value)
inline

The maximum number of objects returned per page.

Definition at line 101 of file SearchProfilesRequest.h.

◆ WithNextToken() [1/3]

SearchProfilesRequest& Aws::CustomerProfiles::Model::SearchProfilesRequest::WithNextToken ( Aws::String &&  value)
inline

The pagination token from the previous SearchProfiles API call.

Definition at line 75 of file SearchProfilesRequest.h.

◆ WithNextToken() [2/3]

SearchProfilesRequest& Aws::CustomerProfiles::Model::SearchProfilesRequest::WithNextToken ( const Aws::String value)
inline

The pagination token from the previous SearchProfiles API call.

Definition at line 70 of file SearchProfilesRequest.h.

◆ WithNextToken() [3/3]

SearchProfilesRequest& Aws::CustomerProfiles::Model::SearchProfilesRequest::WithNextToken ( const char *  value)
inline

The pagination token from the previous SearchProfiles API call.

Definition at line 80 of file SearchProfilesRequest.h.

◆ WithValues() [1/2]

SearchProfilesRequest& Aws::CustomerProfiles::Model::SearchProfilesRequest::WithValues ( Aws::Vector< Aws::String > &&  value)
inline

A list of key values.

Definition at line 238 of file SearchProfilesRequest.h.

◆ WithValues() [2/2]

SearchProfilesRequest& Aws::CustomerProfiles::Model::SearchProfilesRequest::WithValues ( const Aws::Vector< Aws::String > &  value)
inline

A list of key values.

Definition at line 233 of file SearchProfilesRequest.h.


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