com.amazonaws.services.personalizeruntime.model

Class GetRecommendationsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.personalizeruntime.model.GetRecommendationsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetRecommendationsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetRecommendationsRequest()

Method Summary

Modifier and Type	Method and Description
GetRecommendationsRequest	addContextEntry(String key, String value) Add a single Context entry
GetRecommendationsRequest	addFilterValuesEntry(String key, String value) Add a single FilterValues entry
GetRecommendationsRequest	addMetadataColumnsEntry(String key, List<String> value) Add a single MetadataColumns entry
GetRecommendationsRequest	clearContextEntries() Removes all the entries added into Context.
GetRecommendationsRequest	clearFilterValuesEntries() Removes all the entries added into FilterValues.
GetRecommendationsRequest	clearMetadataColumnsEntries() Removes all the entries added into MetadataColumns.
GetRecommendationsRequest	clone()
boolean	equals(Object obj)
String	getCampaignArn() The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
Map<String,String>	getContext() The contextual metadata to use when getting recommendations.
String	getFilterArn() The ARN of the filter to apply to the returned recommendations.
Map<String,String>	getFilterValues() The values to use when filtering recommendations.
String	getItemId() The item ID to provide recommendations for.
Map<String,List<String>>	getMetadataColumns() If you enabled metadata in recommendations when you created or updated the campaign or recommender, specify the metadata columns from your Items dataset to include in item recommendations.
Integer	getNumResults() The number of results to return.
List<Promotion>	getPromotions() The promotions to apply to the recommendation request.
String	getRecommenderArn() The Amazon Resource Name (ARN) of the recommender to use to get recommendations.
String	getUserId() The user ID to provide recommendations for.
int	hashCode()
void	setCampaignArn(String campaignArn) The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
void	setContext(Map<String,String> context) The contextual metadata to use when getting recommendations.
void	setFilterArn(String filterArn) The ARN of the filter to apply to the returned recommendations.
void	setFilterValues(Map<String,String> filterValues) The values to use when filtering recommendations.
void	setItemId(String itemId) The item ID to provide recommendations for.
void	setMetadataColumns(Map<String,List<String>> metadataColumns) If you enabled metadata in recommendations when you created or updated the campaign or recommender, specify the metadata columns from your Items dataset to include in item recommendations.
void	setNumResults(Integer numResults) The number of results to return.
void	setPromotions(Collection<Promotion> promotions) The promotions to apply to the recommendation request.
void	setRecommenderArn(String recommenderArn) The Amazon Resource Name (ARN) of the recommender to use to get recommendations.
void	setUserId(String userId) The user ID to provide recommendations for.
String	toString() Returns a string representation of this object.
GetRecommendationsRequest	withCampaignArn(String campaignArn) The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
GetRecommendationsRequest	withContext(Map<String,String> context) The contextual metadata to use when getting recommendations.
GetRecommendationsRequest	withFilterArn(String filterArn) The ARN of the filter to apply to the returned recommendations.
GetRecommendationsRequest	withFilterValues(Map<String,String> filterValues) The values to use when filtering recommendations.
GetRecommendationsRequest	withItemId(String itemId) The item ID to provide recommendations for.
GetRecommendationsRequest	withMetadataColumns(Map<String,List<String>> metadataColumns) If you enabled metadata in recommendations when you created or updated the campaign or recommender, specify the metadata columns from your Items dataset to include in item recommendations.
GetRecommendationsRequest	withNumResults(Integer numResults) The number of results to return.
GetRecommendationsRequest	withPromotions(Collection<Promotion> promotions) The promotions to apply to the recommendation request.
GetRecommendationsRequest	withPromotions(Promotion... promotions) The promotions to apply to the recommendation request.
GetRecommendationsRequest	withRecommenderArn(String recommenderArn) The Amazon Resource Name (ARN) of the recommender to use to get recommendations.
GetRecommendationsRequest	withUserId(String userId) The user ID to provide recommendations for.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetRecommendationsRequest

public GetRecommendationsRequest()

Method Detail

setCampaignArn

public void setCampaignArn(String campaignArn)

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

Parameters:

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

getCampaignArn

public String getCampaignArn()

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

Returns:

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

withCampaignArn

public GetRecommendationsRequest withCampaignArn(String campaignArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setItemId

public void setItemId(String itemId)

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

Parameters:

itemId - The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

getItemId

public String getItemId()

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

Returns:

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

withItemId

public GetRecommendationsRequest withItemId(String itemId)

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

Parameters:

itemId - The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

Returns:

Returns a reference to this object so that method calls can be chained together.

setUserId

public void setUserId(String userId)

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

Parameters:

userId - The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

getUserId

public String getUserId()

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

Returns:

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

withUserId

public GetRecommendationsRequest withUserId(String userId)

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

Parameters:

userId - The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNumResults

public void setNumResults(Integer numResults)

The number of results to return. The default is 25. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.

Parameters:

numResults - The number of results to return. The default is 25. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.

getNumResults

public Integer getNumResults()

The number of results to return. The default is 25. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.

Returns:

The number of results to return. The default is 25. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.

withNumResults

public GetRecommendationsRequest withNumResults(Integer numResults)

The number of results to return. The default is 25. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.

Parameters:

numResults - The number of results to return. The default is 25. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.

Returns:

Returns a reference to this object so that method calls can be chained together.

getContext

public Map<String,String> getContext()

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.

Returns:

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.

setContext

public void setContext(Map<String,String> context)

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.

Parameters:

context - 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.

withContext

public GetRecommendationsRequest withContext(Map<String,String> context)

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.

Parameters:

context - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

addContextEntry

public GetRecommendationsRequest addContextEntry(String key,
                                                 String value)

Add a single Context entry

See Also:

withContext(java.util.Map<java.lang.String, java.lang.String>)

clearContextEntries

public GetRecommendationsRequest clearContextEntries()

Removes all the entries added into Context.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFilterArn

public void setFilterArn(String filterArn)

The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.

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

Parameters:

filterArn - The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.

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

getFilterArn

public String getFilterArn()

The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.

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

Returns:

The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.

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

withFilterArn

public GetRecommendationsRequest withFilterArn(String filterArn)

The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.

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

Parameters:

filterArn - The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getFilterValues

public Map<String,String> getFilterValues()

The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.

For filter expressions that use an INCLUDE element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude items, you can omit the filter-values.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.

For more information, see Filtering recommendations and user segments.

Returns:

The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.

For filter expressions that use an INCLUDE element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude items, you can omit the filter-values.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.

For more information, see Filtering recommendations and user segments.

setFilterValues

public void setFilterValues(Map<String,String> filterValues)

The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.

For filter expressions that use an INCLUDE element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude items, you can omit the filter-values.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.

For more information, see Filtering recommendations and user segments.

Parameters:

filterValues - The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.

For filter expressions that use an INCLUDE element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude items, you can omit the filter-values.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.

For more information, see Filtering recommendations and user segments.

withFilterValues

public GetRecommendationsRequest withFilterValues(Map<String,String> filterValues)

The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.

For filter expressions that use an INCLUDE element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude items, you can omit the filter-values.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.

For more information, see Filtering recommendations and user segments.

Parameters:

filterValues - The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.

For filter expressions that use an INCLUDE element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude items, you can omit the filter-values.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.

For more information, see Filtering recommendations and user segments.

Returns:

Returns a reference to this object so that method calls can be chained together.

addFilterValuesEntry

public GetRecommendationsRequest addFilterValuesEntry(String key,
                                                      String value)

Add a single FilterValues entry

See Also:

withFilterValues(java.util.Map<java.lang.String, java.lang.String>)

clearFilterValuesEntries

public GetRecommendationsRequest clearFilterValuesEntries()

Removes all the entries added into FilterValues.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRecommenderArn

public void setRecommenderArn(String recommenderArn)

The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you created a Domain dataset group with a recommender for a domain use case.

Parameters:

recommenderArn - The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you created a Domain dataset group with a recommender for a domain use case.

getRecommenderArn

public String getRecommenderArn()

The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you created a Domain dataset group with a recommender for a domain use case.

Returns:

The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you created a Domain dataset group with a recommender for a domain use case.

withRecommenderArn

public GetRecommendationsRequest withRecommenderArn(String recommenderArn)

The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you created a Domain dataset group with a recommender for a domain use case.

Parameters:

recommenderArn - The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you created a Domain dataset group with a recommender for a domain use case.

Returns:

Returns a reference to this object so that method calls can be chained together.

getPromotions

public List<Promotion> getPromotions()

The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.

Returns:

The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.

setPromotions

public void setPromotions(Collection<Promotion> promotions)

The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.

Parameters:

promotions - The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.

withPromotions

public GetRecommendationsRequest withPromotions(Promotion... promotions)

The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.

NOTE: This method appends the values to the existing list (if any). Use setPromotions(java.util.Collection) or withPromotions(java.util.Collection) if you want to override the existing values.

Parameters:

promotions - The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.

Returns:

Returns a reference to this object so that method calls can be chained together.

withPromotions

public GetRecommendationsRequest withPromotions(Collection<Promotion> promotions)

The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.

Parameters:

promotions - The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.

Returns:

Returns a reference to this object so that method calls can be chained together.

getMetadataColumns

public Map<String,List<String>> getMetadataColumns()

If you enabled metadata in recommendations when you created or updated the campaign or recommender, specify the metadata columns from your Items dataset to include in item recommendations. The map key is ITEMS and the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10.

For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a recommender.

Returns:

If you enabled metadata in recommendations when you created or updated the campaign or recommender, specify the metadata columns from your Items dataset to include in item recommendations. The map key is ITEMS and the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10.

For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a recommender.

setMetadataColumns

public void setMetadataColumns(Map<String,List<String>> metadataColumns)

If you enabled metadata in recommendations when you created or updated the campaign or recommender, specify the metadata columns from your Items dataset to include in item recommendations. The map key is ITEMS and the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10.

For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a recommender.

Parameters:

metadataColumns - If you enabled metadata in recommendations when you created or updated the campaign or recommender, specify the metadata columns from your Items dataset to include in item recommendations. The map key is ITEMS and the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10.

For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a recommender.

withMetadataColumns

public GetRecommendationsRequest withMetadataColumns(Map<String,List<String>> metadataColumns)

If you enabled metadata in recommendations when you created or updated the campaign or recommender, specify the metadata columns from your Items dataset to include in item recommendations. The map key is ITEMS and the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10.

For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a recommender.

Parameters:

metadataColumns - If you enabled metadata in recommendations when you created or updated the campaign or recommender, specify the metadata columns from your Items dataset to include in item recommendations. The map key is ITEMS and the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10.

For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a recommender.

Returns:

Returns a reference to this object so that method calls can be chained together.

addMetadataColumnsEntry

public GetRecommendationsRequest addMetadataColumnsEntry(String key,
                                                         List<String> value)

Add a single MetadataColumns entry

See Also:

withMetadataColumns(java.util.Map<java.lang.String, java.util.List<java.lang.String>>)

clearMetadataColumnsEntries

public GetRecommendationsRequest clearMetadataColumnsEntries()

Removes all the entries added into MetadataColumns.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetRecommendationsRequest clone()

Overrides:

clone in class AmazonWebServiceRequest