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

#include <GetRecommendationsRequest.h>

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

Public Member Functions

 GetRecommendationsRequest ()
 
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)
 
GetRecommendationsRequestWithCampaignArn (const Aws::String &value)
 
GetRecommendationsRequestWithCampaignArn (Aws::String &&value)
 
GetRecommendationsRequestWithCampaignArn (const char *value)
 
const Aws::StringGetItemId () const
 
bool ItemIdHasBeenSet () const
 
void SetItemId (const Aws::String &value)
 
void SetItemId (Aws::String &&value)
 
void SetItemId (const char *value)
 
GetRecommendationsRequestWithItemId (const Aws::String &value)
 
GetRecommendationsRequestWithItemId (Aws::String &&value)
 
GetRecommendationsRequestWithItemId (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)
 
GetRecommendationsRequestWithUserId (const Aws::String &value)
 
GetRecommendationsRequestWithUserId (Aws::String &&value)
 
GetRecommendationsRequestWithUserId (const char *value)
 
int GetNumResults () const
 
bool NumResultsHasBeenSet () const
 
void SetNumResults (int value)
 
GetRecommendationsRequestWithNumResults (int 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)
 
GetRecommendationsRequestWithContext (const Aws::Map< Aws::String, Aws::String > &value)
 
GetRecommendationsRequestWithContext (Aws::Map< Aws::String, Aws::String > &&value)
 
GetRecommendationsRequestAddContext (const Aws::String &key, const Aws::String &value)
 
GetRecommendationsRequestAddContext (Aws::String &&key, const Aws::String &value)
 
GetRecommendationsRequestAddContext (const Aws::String &key, Aws::String &&value)
 
GetRecommendationsRequestAddContext (Aws::String &&key, Aws::String &&value)
 
GetRecommendationsRequestAddContext (const char *key, Aws::String &&value)
 
GetRecommendationsRequestAddContext (Aws::String &&key, const char *value)
 
GetRecommendationsRequestAddContext (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)
 
GetRecommendationsRequestWithFilterArn (const Aws::String &value)
 
GetRecommendationsRequestWithFilterArn (Aws::String &&value)
 
GetRecommendationsRequestWithFilterArn (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 22 of file GetRecommendationsRequest.h.

Constructor & Destructor Documentation

◆ GetRecommendationsRequest()

Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::GetRecommendationsRequest ( )

Member Function Documentation

◆ AddContext() [1/7]

GetRecommendationsRequest& Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::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 258 of file GetRecommendationsRequest.h.

◆ AddContext() [2/7]

GetRecommendationsRequest& Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::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 266 of file GetRecommendationsRequest.h.

◆ AddContext() [3/7]

GetRecommendationsRequest& Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::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 274 of file GetRecommendationsRequest.h.

◆ AddContext() [4/7]

GetRecommendationsRequest& Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::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 282 of file GetRecommendationsRequest.h.

◆ AddContext() [5/7]

GetRecommendationsRequest& Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::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 290 of file GetRecommendationsRequest.h.

◆ AddContext() [6/7]

GetRecommendationsRequest& Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::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 298 of file GetRecommendationsRequest.h.

◆ AddContext() [7/7]

GetRecommendationsRequest& Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::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 306 of file GetRecommendationsRequest.h.

◆ CampaignArnHasBeenSet()

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

The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

Definition at line 46 of file GetRecommendationsRequest.h.

◆ ContextHasBeenSet()

bool Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::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 218 of file GetRecommendationsRequest.h.

◆ FilterArnHasBeenSet()

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

The ARN of the filter to apply to the returned recommendations. For more information, see Using Filters with Amazon Personalize.

When using this parameter, be sure the filter resource is ACTIVE.

Definition at line 325 of file GetRecommendationsRequest.h.

◆ GetCampaignArn()

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

The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

Definition at line 40 of file GetRecommendationsRequest.h.

◆ GetContext()

const Aws::Map<Aws::String, Aws::String>& Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::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 210 of file GetRecommendationsRequest.h.

◆ GetFilterArn()

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

The ARN of the filter to apply to the returned recommendations. For more information, see Using Filters with Amazon Personalize.

When using this parameter, be sure the filter resource is ACTIVE.

Definition at line 316 of file GetRecommendationsRequest.h.

◆ GetItemId()

const Aws::String& Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::GetItemId ( ) const
inline

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

Definition at line 89 of file GetRecommendationsRequest.h.

◆ GetNumResults()

int Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::GetNumResults ( ) const
inline

The number of results to return. The default is 25. The maximum is 500.

Definition at line 186 of file GetRecommendationsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file GetRecommendationsRequest.h.

◆ GetUserId()

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

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

Definition at line 138 of file GetRecommendationsRequest.h.

◆ ItemIdHasBeenSet()

bool Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::ItemIdHasBeenSet ( ) const
inline

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

Definition at line 95 of file GetRecommendationsRequest.h.

◆ NumResultsHasBeenSet()

bool Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::NumResultsHasBeenSet ( ) const
inline

The number of results to return. The default is 25. The maximum is 500.

Definition at line 191 of file GetRecommendationsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCampaignArn() [1/3]

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

The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

Definition at line 52 of file GetRecommendationsRequest.h.

◆ SetCampaignArn() [2/3]

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

The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

Definition at line 58 of file GetRecommendationsRequest.h.

◆ SetCampaignArn() [3/3]

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

The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

Definition at line 64 of file GetRecommendationsRequest.h.

◆ SetContext() [1/2]

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

◆ SetContext() [2/2]

void Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::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 234 of file GetRecommendationsRequest.h.

◆ SetFilterArn() [1/3]

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

The ARN of the filter to apply to the returned recommendations. For more information, see Using Filters with Amazon Personalize.

When using this parameter, be sure the filter resource is ACTIVE.

Definition at line 334 of file GetRecommendationsRequest.h.

◆ SetFilterArn() [2/3]

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

The ARN of the filter to apply to the returned recommendations. For more information, see Using Filters with Amazon Personalize.

When using this parameter, be sure the filter resource is ACTIVE.

Definition at line 343 of file GetRecommendationsRequest.h.

◆ SetFilterArn() [3/3]

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

The ARN of the filter to apply to the returned recommendations. For more information, see Using Filters with Amazon Personalize.

When using this parameter, be sure the filter resource is ACTIVE.

Definition at line 352 of file GetRecommendationsRequest.h.

◆ SetItemId() [1/3]

void Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::SetItemId ( const Aws::String value)
inline

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

Definition at line 101 of file GetRecommendationsRequest.h.

◆ SetItemId() [2/3]

void Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::SetItemId ( Aws::String &&  value)
inline

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

Definition at line 107 of file GetRecommendationsRequest.h.

◆ SetItemId() [3/3]

void Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::SetItemId ( const char *  value)
inline

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

Definition at line 113 of file GetRecommendationsRequest.h.

◆ SetNumResults()

void Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::SetNumResults ( int  value)
inline

The number of results to return. The default is 25. The maximum is 500.

Definition at line 196 of file GetRecommendationsRequest.h.

◆ SetUserId() [1/3]

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

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

Definition at line 150 of file GetRecommendationsRequest.h.

◆ SetUserId() [2/3]

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

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

Definition at line 156 of file GetRecommendationsRequest.h.

◆ SetUserId() [3/3]

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

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

Definition at line 162 of file GetRecommendationsRequest.h.

◆ UserIdHasBeenSet()

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

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

Definition at line 144 of file GetRecommendationsRequest.h.

◆ WithCampaignArn() [1/3]

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

The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

Definition at line 70 of file GetRecommendationsRequest.h.

◆ WithCampaignArn() [2/3]

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

The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

Definition at line 76 of file GetRecommendationsRequest.h.

◆ WithCampaignArn() [3/3]

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

The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

Definition at line 82 of file GetRecommendationsRequest.h.

◆ WithContext() [1/2]

GetRecommendationsRequest& Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::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 242 of file GetRecommendationsRequest.h.

◆ WithContext() [2/2]

GetRecommendationsRequest& Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::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 250 of file GetRecommendationsRequest.h.

◆ WithFilterArn() [1/3]

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

The ARN of the filter to apply to the returned recommendations. For more information, see Using Filters with Amazon Personalize.

When using this parameter, be sure the filter resource is ACTIVE.

Definition at line 361 of file GetRecommendationsRequest.h.

◆ WithFilterArn() [2/3]

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

The ARN of the filter to apply to the returned recommendations. For more information, see Using Filters with Amazon Personalize.

When using this parameter, be sure the filter resource is ACTIVE.

Definition at line 370 of file GetRecommendationsRequest.h.

◆ WithFilterArn() [3/3]

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

The ARN of the filter to apply to the returned recommendations. For more information, see Using Filters with Amazon Personalize.

When using this parameter, be sure the filter resource is ACTIVE.

Definition at line 379 of file GetRecommendationsRequest.h.

◆ WithItemId() [1/3]

GetRecommendationsRequest& Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::WithItemId ( const Aws::String value)
inline

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

Definition at line 119 of file GetRecommendationsRequest.h.

◆ WithItemId() [2/3]

GetRecommendationsRequest& Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::WithItemId ( Aws::String &&  value)
inline

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

Definition at line 125 of file GetRecommendationsRequest.h.

◆ WithItemId() [3/3]

GetRecommendationsRequest& Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::WithItemId ( const char *  value)
inline

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

Definition at line 131 of file GetRecommendationsRequest.h.

◆ WithNumResults()

GetRecommendationsRequest& Aws::PersonalizeRuntime::Model::GetRecommendationsRequest::WithNumResults ( int  value)
inline

The number of results to return. The default is 25. The maximum is 500.

Definition at line 201 of file GetRecommendationsRequest.h.

◆ WithUserId() [1/3]

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

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

Definition at line 168 of file GetRecommendationsRequest.h.

◆ WithUserId() [2/3]

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

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

Definition at line 174 of file GetRecommendationsRequest.h.

◆ WithUserId() [3/3]

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

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

Definition at line 180 of file GetRecommendationsRequest.h.


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