com.amazonaws.services.personalizeruntime.model

Class GetPersonalizedRankingRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.personalizeruntime.model.GetPersonalizedRankingRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetPersonalizedRankingRequest
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
GetPersonalizedRankingRequest()

Method Summary

Modifier and Type	Method and Description
GetPersonalizedRankingRequest	addContextEntry(String key, String value) Add a single Context entry
GetPersonalizedRankingRequest	addFilterValuesEntry(String key, String value) Add a single FilterValues entry
GetPersonalizedRankingRequest	addMetadataColumnsEntry(String key, List<String> value) Add a single MetadataColumns entry
GetPersonalizedRankingRequest	clearContextEntries() Removes all the entries added into Context.
GetPersonalizedRankingRequest	clearFilterValuesEntries() Removes all the entries added into FilterValues.
GetPersonalizedRankingRequest	clearMetadataColumnsEntries() Removes all the entries added into MetadataColumns.
GetPersonalizedRankingRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCampaignArn() The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.
Map<String,String>	getContext() The contextual metadata to use when getting recommendations.
String	getFilterArn() The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user.
Map<String,String>	getFilterValues() The values to use when filtering recommendations.
List<String>	getInputList() A list of items (by itemId) to rank.
Map<String,List<String>>	getMetadataColumns() If you enabled metadata in recommendations when you created or updated the campaign, specify metadata columns from your Items dataset to include in the personalized ranking.
String	getUserId() The user for which you want the campaign to provide a personalized ranking.
int	hashCode()
void	setCampaignArn(String campaignArn) The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.
void	setContext(Map<String,String> context) The contextual metadata to use when getting recommendations.
void	setFilterArn(String filterArn) The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user.
void	setFilterValues(Map<String,String> filterValues) The values to use when filtering recommendations.
void	setInputList(Collection<String> inputList) A list of items (by itemId) to rank.
void	setMetadataColumns(Map<String,List<String>> metadataColumns) If you enabled metadata in recommendations when you created or updated the campaign, specify metadata columns from your Items dataset to include in the personalized ranking.
void	setUserId(String userId) The user for which you want the campaign to provide a personalized ranking.
String	toString() Returns a string representation of this object.
GetPersonalizedRankingRequest	withCampaignArn(String campaignArn) The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.
GetPersonalizedRankingRequest	withContext(Map<String,String> context) The contextual metadata to use when getting recommendations.
GetPersonalizedRankingRequest	withFilterArn(String filterArn) The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user.
GetPersonalizedRankingRequest	withFilterValues(Map<String,String> filterValues) The values to use when filtering recommendations.
GetPersonalizedRankingRequest	withInputList(Collection<String> inputList) A list of items (by itemId) to rank.
GetPersonalizedRankingRequest	withInputList(String... inputList) A list of items (by itemId) to rank.
GetPersonalizedRankingRequest	withMetadataColumns(Map<String,List<String>> metadataColumns) If you enabled metadata in recommendations when you created or updated the campaign, specify metadata columns from your Items dataset to include in the personalized ranking.
GetPersonalizedRankingRequest	withUserId(String userId) The user for which you want the campaign to provide a personalized ranking.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, 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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetPersonalizedRankingRequest

public GetPersonalizedRankingRequest()

Method Detail

setCampaignArn

public void setCampaignArn(String campaignArn)

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

Parameters:

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

getCampaignArn

public String getCampaignArn()

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

Returns:

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

withCampaignArn

public GetPersonalizedRankingRequest withCampaignArn(String campaignArn)

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

Parameters:

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

Returns:

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

getInputList

public List<String> getInputList()

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. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.

Returns:

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. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.

setInputList

public void setInputList(Collection<String> inputList)

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. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.

Parameters:

inputList - 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. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.

withInputList

public GetPersonalizedRankingRequest withInputList(String... inputList)

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. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.

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

Parameters:

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

withInputList

public GetPersonalizedRankingRequest withInputList(Collection<String> inputList)

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. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.

Parameters:

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

setUserId

public void setUserId(String userId)

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

Parameters:

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

getUserId

public String getUserId()

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

Returns:

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

withUserId

public GetPersonalizedRankingRequest withUserId(String userId)

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

Parameters:

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

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 GetPersonalizedRankingRequest 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 GetPersonalizedRankingRequest addContextEntry(String key,
                                                     String value)

Add a single Context entry

See Also:

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

clearContextEntries

public GetPersonalizedRankingRequest 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 Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user. For more information, see Filtering Recommendations.

Parameters:

filterArn - The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user. For more information, see Filtering Recommendations.

getFilterArn

public String getFilterArn()

The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user. For more information, see Filtering Recommendations.

Returns:

The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user. For more information, see Filtering Recommendations.

withFilterArn

public GetPersonalizedRankingRequest withFilterArn(String filterArn)

The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user. For more information, see Filtering Recommendations.

Parameters:

filterArn - The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user. For more information, see Filtering Recommendations.

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.

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.

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.

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.

withFilterValues

public GetPersonalizedRankingRequest 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.

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.

Returns:

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

addFilterValuesEntry

public GetPersonalizedRankingRequest addFilterValuesEntry(String key,
                                                          String value)

Add a single FilterValues entry

See Also:

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

clearFilterValuesEntries

public GetPersonalizedRankingRequest clearFilterValuesEntries()

Removes all the entries added into FilterValues.

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, specify metadata columns from your Items dataset to include in the personalized ranking. 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.

Returns:

If you enabled metadata in recommendations when you created or updated the campaign, specify metadata columns from your Items dataset to include in the personalized ranking. 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.

setMetadataColumns

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

If you enabled metadata in recommendations when you created or updated the campaign, specify metadata columns from your Items dataset to include in the personalized ranking. 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.

Parameters:

metadataColumns - If you enabled metadata in recommendations when you created or updated the campaign, specify metadata columns from your Items dataset to include in the personalized ranking. 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.

withMetadataColumns

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

If you enabled metadata in recommendations when you created or updated the campaign, specify metadata columns from your Items dataset to include in the personalized ranking. 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.

Parameters:

metadataColumns - If you enabled metadata in recommendations when you created or updated the campaign, specify metadata columns from your Items dataset to include in the personalized ranking. 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.

Returns:

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

addMetadataColumnsEntry

public GetPersonalizedRankingRequest 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 GetPersonalizedRankingRequest 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 GetPersonalizedRankingRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()