@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GetRecommendationsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
GetRecommendationsRequest() |
| 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()
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 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.
|
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, withSdkRequestTimeoutpublic void setCampaignArn(String campaignArn)
The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
campaignArn - The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.public String getCampaignArn()
The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
public GetRecommendationsRequest withCampaignArn(String campaignArn)
The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
campaignArn - The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.public void setItemId(String itemId)
The item ID to provide recommendations for.
Required for RELATED_ITEMS recipe type.
itemId - The item ID to provide recommendations for.
Required for RELATED_ITEMS recipe type.
public String getItemId()
The item ID to provide recommendations for.
Required for RELATED_ITEMS recipe type.
Required for RELATED_ITEMS recipe type.
public GetRecommendationsRequest withItemId(String itemId)
The item ID to provide recommendations for.
Required for RELATED_ITEMS recipe type.
itemId - The item ID to provide recommendations for.
Required for RELATED_ITEMS recipe type.
public void setUserId(String userId)
The user ID to provide recommendations for.
Required for USER_PERSONALIZATION recipe type.
userId - The user ID to provide recommendations for.
Required for USER_PERSONALIZATION recipe type.
public String getUserId()
The user ID to provide recommendations for.
Required for USER_PERSONALIZATION recipe type.
Required for USER_PERSONALIZATION recipe type.
public GetRecommendationsRequest withUserId(String userId)
The user ID to provide recommendations for.
Required for USER_PERSONALIZATION recipe type.
userId - The user ID to provide recommendations for.
Required for USER_PERSONALIZATION recipe type.
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.
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.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.
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.
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.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.
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.
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.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.
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.public GetRecommendationsRequest addContextEntry(String key, String value)
public GetRecommendationsRequest clearContextEntries()
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.
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.
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.
When using this parameter, be sure the filter resource is ACTIVE.
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.
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.
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.
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.
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.
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.
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.
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.
public GetRecommendationsRequest addFilterValuesEntry(String key, String value)
public GetRecommendationsRequest clearFilterValuesEntries()
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.
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.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.
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.
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.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.
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.
promotions - The promotions to apply to the recommendation request. A promotion defines additional business rules that
apply to a configurable subset of recommended items.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.
promotions - The promotions to apply to the recommendation request. A promotion defines additional business rules that
apply to a configurable subset of recommended items.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.
promotions - The promotions to apply to the recommendation request. A promotion defines additional business rules that
apply to a configurable subset of recommended items.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.
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.
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.
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.
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.
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.
public GetRecommendationsRequest addMetadataColumnsEntry(String key, List<String> value)
public GetRecommendationsRequest clearMetadataColumnsEntries()
public String toString()
toString in class ObjectObject.toString()public GetRecommendationsRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()