AWS SDK for C++  1.8.78
AWS SDK for C++
Public Member Functions | List of all members
Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest Class Reference

#include <GetPersonalizedRankingRequest.h>

+ Inheritance diagram for Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest:

Public Member Functions

 GetPersonalizedRankingRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetCampaignArn () const
 
bool CampaignArnHasBeenSet () const
 
void SetCampaignArn (const Aws::String &value)
 
void SetCampaignArn (Aws::String &&value)
 
void SetCampaignArn (const char *value)
 
GetPersonalizedRankingRequestWithCampaignArn (const Aws::String &value)
 
GetPersonalizedRankingRequestWithCampaignArn (Aws::String &&value)
 
GetPersonalizedRankingRequestWithCampaignArn (const char *value)
 
const Aws::Vector< Aws::String > & GetInputList () const
 
bool InputListHasBeenSet () const
 
void SetInputList (const Aws::Vector< Aws::String > &value)
 
void SetInputList (Aws::Vector< Aws::String > &&value)
 
GetPersonalizedRankingRequestWithInputList (const Aws::Vector< Aws::String > &value)
 
GetPersonalizedRankingRequestWithInputList (Aws::Vector< Aws::String > &&value)
 
GetPersonalizedRankingRequestAddInputList (const Aws::String &value)
 
GetPersonalizedRankingRequestAddInputList (Aws::String &&value)
 
GetPersonalizedRankingRequestAddInputList (const char *value)
 
const Aws::StringGetUserId () const
 
bool UserIdHasBeenSet () const
 
void SetUserId (const Aws::String &value)
 
void SetUserId (Aws::String &&value)
 
void SetUserId (const char *value)
 
GetPersonalizedRankingRequestWithUserId (const Aws::String &value)
 
GetPersonalizedRankingRequestWithUserId (Aws::String &&value)
 
GetPersonalizedRankingRequestWithUserId (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetContext () const
 
bool ContextHasBeenSet () const
 
void SetContext (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetContext (Aws::Map< Aws::String, Aws::String > &&value)
 
GetPersonalizedRankingRequestWithContext (const Aws::Map< Aws::String, Aws::String > &value)
 
GetPersonalizedRankingRequestWithContext (Aws::Map< Aws::String, Aws::String > &&value)
 
GetPersonalizedRankingRequestAddContext (const Aws::String &key, const Aws::String &value)
 
GetPersonalizedRankingRequestAddContext (Aws::String &&key, const Aws::String &value)
 
GetPersonalizedRankingRequestAddContext (const Aws::String &key, Aws::String &&value)
 
GetPersonalizedRankingRequestAddContext (Aws::String &&key, Aws::String &&value)
 
GetPersonalizedRankingRequestAddContext (const char *key, Aws::String &&value)
 
GetPersonalizedRankingRequestAddContext (Aws::String &&key, const char *value)
 
GetPersonalizedRankingRequestAddContext (const char *key, const char *value)
 
const Aws::StringGetFilterArn () const
 
bool FilterArnHasBeenSet () const
 
void SetFilterArn (const Aws::String &value)
 
void SetFilterArn (Aws::String &&value)
 
void SetFilterArn (const char *value)
 
GetPersonalizedRankingRequestWithFilterArn (const Aws::String &value)
 
GetPersonalizedRankingRequestWithFilterArn (Aws::String &&value)
 
GetPersonalizedRankingRequestWithFilterArn (const char *value)
 
- Public Member Functions inherited from Aws::PersonalizeRuntime::PersonalizeRuntimeRequest
virtual ~PersonalizeRuntimeRequest ()
 
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 AddQueryStringParameters (Aws::Http::URI &uri) const
 
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::PersonalizeRuntime::PersonalizeRuntimeRequest
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 23 of file GetPersonalizedRankingRequest.h.

Constructor & Destructor Documentation

◆ GetPersonalizedRankingRequest()

Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::GetPersonalizedRankingRequest ( )

Member Function Documentation

◆ AddContext() [1/7]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::AddContext ( const Aws::String key,
const Aws::String value 
)
inline

The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

Definition at line 253 of file GetPersonalizedRankingRequest.h.

◆ AddContext() [2/7]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::AddContext ( Aws::String &&  key,
const Aws::String value 
)
inline

The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

Definition at line 261 of file GetPersonalizedRankingRequest.h.

◆ AddContext() [3/7]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::AddContext ( const Aws::String key,
Aws::String &&  value 
)
inline

The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

Definition at line 269 of file GetPersonalizedRankingRequest.h.

◆ AddContext() [4/7]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::AddContext ( Aws::String &&  key,
Aws::String &&  value 
)
inline

The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

Definition at line 277 of file GetPersonalizedRankingRequest.h.

◆ AddContext() [5/7]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::AddContext ( const char *  key,
Aws::String &&  value 
)
inline

The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

Definition at line 285 of file GetPersonalizedRankingRequest.h.

◆ AddContext() [6/7]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::AddContext ( Aws::String &&  key,
const char *  value 
)
inline

The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

Definition at line 293 of file GetPersonalizedRankingRequest.h.

◆ AddContext() [7/7]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::AddContext ( const char *  key,
const char *  value 
)
inline

The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

Definition at line 301 of file GetPersonalizedRankingRequest.h.

◆ AddInputList() [1/3]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::AddInputList ( const Aws::String value)
inline

A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. The maximum is 500.

Definition at line 133 of file GetPersonalizedRankingRequest.h.

◆ AddInputList() [2/3]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::AddInputList ( Aws::String &&  value)
inline

A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. The maximum is 500.

Definition at line 140 of file GetPersonalizedRankingRequest.h.

◆ AddInputList() [3/3]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::AddInputList ( const char *  value)
inline

A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. The maximum is 500.

Definition at line 147 of file GetPersonalizedRankingRequest.h.

◆ CampaignArnHasBeenSet()

bool Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::CampaignArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.

Definition at line 47 of file GetPersonalizedRankingRequest.h.

◆ ContextHasBeenSet()

bool Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::ContextHasBeenSet ( ) const
inline

The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

Definition at line 213 of file GetPersonalizedRankingRequest.h.

◆ FilterArnHasBeenSet()

bool Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::FilterArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of a filter you created to include or exclude items from recommendations for a given user.

Definition at line 314 of file GetPersonalizedRankingRequest.h.

◆ GetCampaignArn()

const Aws::String& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::GetCampaignArn ( ) const
inline

The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.

Definition at line 41 of file GetPersonalizedRankingRequest.h.

◆ GetContext()

const Aws::Map<Aws::String, Aws::String>& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::GetContext ( ) const
inline

The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

Definition at line 205 of file GetPersonalizedRankingRequest.h.

◆ GetFilterArn()

const Aws::String& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::GetFilterArn ( ) const
inline

The Amazon Resource Name (ARN) of a filter you created to include or exclude items from recommendations for a given user.

Definition at line 308 of file GetPersonalizedRankingRequest.h.

◆ GetInputList()

const Aws::Vector<Aws::String>& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::GetInputList ( ) const
inline

A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. The maximum is 500.

Definition at line 91 of file GetPersonalizedRankingRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file GetPersonalizedRankingRequest.h.

◆ GetUserId()

const Aws::String& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::GetUserId ( ) const
inline

The user for which you want the campaign to provide a personalized ranking.

Definition at line 154 of file GetPersonalizedRankingRequest.h.

◆ InputListHasBeenSet()

bool Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::InputListHasBeenSet ( ) const
inline

A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. The maximum is 500.

Definition at line 98 of file GetPersonalizedRankingRequest.h.

◆ SerializePayload()

Aws::String Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCampaignArn() [1/3]

void Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::SetCampaignArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.

Definition at line 53 of file GetPersonalizedRankingRequest.h.

◆ SetCampaignArn() [2/3]

void Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::SetCampaignArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.

Definition at line 59 of file GetPersonalizedRankingRequest.h.

◆ SetCampaignArn() [3/3]

void Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::SetCampaignArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.

Definition at line 65 of file GetPersonalizedRankingRequest.h.

◆ SetContext() [1/2]

void Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::SetContext ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

Definition at line 221 of file GetPersonalizedRankingRequest.h.

◆ SetContext() [2/2]

void Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::SetContext ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

Definition at line 229 of file GetPersonalizedRankingRequest.h.

◆ SetFilterArn() [1/3]

void Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::SetFilterArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of a filter you created to include or exclude items from recommendations for a given user.

Definition at line 320 of file GetPersonalizedRankingRequest.h.

◆ SetFilterArn() [2/3]

void Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::SetFilterArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of a filter you created to include or exclude items from recommendations for a given user.

Definition at line 326 of file GetPersonalizedRankingRequest.h.

◆ SetFilterArn() [3/3]

void Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::SetFilterArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of a filter you created to include or exclude items from recommendations for a given user.

Definition at line 332 of file GetPersonalizedRankingRequest.h.

◆ SetInputList() [1/2]

void Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::SetInputList ( const Aws::Vector< Aws::String > &  value)
inline

A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. The maximum is 500.

Definition at line 105 of file GetPersonalizedRankingRequest.h.

◆ SetInputList() [2/2]

void Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::SetInputList ( Aws::Vector< Aws::String > &&  value)
inline

A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. The maximum is 500.

Definition at line 112 of file GetPersonalizedRankingRequest.h.

◆ SetUserId() [1/3]

void Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::SetUserId ( const Aws::String value)
inline

The user for which you want the campaign to provide a personalized ranking.

Definition at line 166 of file GetPersonalizedRankingRequest.h.

◆ SetUserId() [2/3]

void Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::SetUserId ( Aws::String &&  value)
inline

The user for which you want the campaign to provide a personalized ranking.

Definition at line 172 of file GetPersonalizedRankingRequest.h.

◆ SetUserId() [3/3]

void Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::SetUserId ( const char *  value)
inline

The user for which you want the campaign to provide a personalized ranking.

Definition at line 178 of file GetPersonalizedRankingRequest.h.

◆ UserIdHasBeenSet()

bool Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::UserIdHasBeenSet ( ) const
inline

The user for which you want the campaign to provide a personalized ranking.

Definition at line 160 of file GetPersonalizedRankingRequest.h.

◆ WithCampaignArn() [1/3]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::WithCampaignArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.

Definition at line 71 of file GetPersonalizedRankingRequest.h.

◆ WithCampaignArn() [2/3]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::WithCampaignArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.

Definition at line 77 of file GetPersonalizedRankingRequest.h.

◆ WithCampaignArn() [3/3]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::WithCampaignArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.

Definition at line 83 of file GetPersonalizedRankingRequest.h.

◆ WithContext() [1/2]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::WithContext ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

Definition at line 237 of file GetPersonalizedRankingRequest.h.

◆ WithContext() [2/2]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::WithContext ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

Definition at line 245 of file GetPersonalizedRankingRequest.h.

◆ WithFilterArn() [1/3]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::WithFilterArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of a filter you created to include or exclude items from recommendations for a given user.

Definition at line 338 of file GetPersonalizedRankingRequest.h.

◆ WithFilterArn() [2/3]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::WithFilterArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of a filter you created to include or exclude items from recommendations for a given user.

Definition at line 344 of file GetPersonalizedRankingRequest.h.

◆ WithFilterArn() [3/3]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::WithFilterArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of a filter you created to include or exclude items from recommendations for a given user.

Definition at line 350 of file GetPersonalizedRankingRequest.h.

◆ WithInputList() [1/2]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::WithInputList ( const Aws::Vector< Aws::String > &  value)
inline

A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. The maximum is 500.

Definition at line 119 of file GetPersonalizedRankingRequest.h.

◆ WithInputList() [2/2]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::WithInputList ( Aws::Vector< Aws::String > &&  value)
inline

A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. The maximum is 500.

Definition at line 126 of file GetPersonalizedRankingRequest.h.

◆ WithUserId() [1/3]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::WithUserId ( const Aws::String value)
inline

The user for which you want the campaign to provide a personalized ranking.

Definition at line 184 of file GetPersonalizedRankingRequest.h.

◆ WithUserId() [2/3]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::WithUserId ( Aws::String &&  value)
inline

The user for which you want the campaign to provide a personalized ranking.

Definition at line 190 of file GetPersonalizedRankingRequest.h.

◆ WithUserId() [3/3]

GetPersonalizedRankingRequest& Aws::PersonalizeRuntime::Model::GetPersonalizedRankingRequest::WithUserId ( const char *  value)
inline

The user for which you want the campaign to provide a personalized ranking.

Definition at line 196 of file GetPersonalizedRankingRequest.h.


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