com.amazonaws.services.personalizeruntime.model

Class GetActionRecommendationsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.personalizeruntime.model.GetActionRecommendationsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
GetActionRecommendationsRequest	addFilterValuesEntry(String key, String value) Add a single FilterValues entry
GetActionRecommendationsRequest	clearFilterValuesEntries() Removes all the entries added into FilterValues.
GetActionRecommendationsRequest	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 action 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.
Integer	getNumResults() The number of results to return.
String	getUserId() The user ID of the user to provide action recommendations for.
int	hashCode()
void	setCampaignArn(String campaignArn) The Amazon Resource Name (ARN) of the campaign to use for getting action 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	setNumResults(Integer numResults) The number of results to return.
void	setUserId(String userId) The user ID of the user to provide action recommendations for.
String	toString() Returns a string representation of this object.
GetActionRecommendationsRequest	withCampaignArn(String campaignArn) The Amazon Resource Name (ARN) of the campaign to use for getting action recommendations.
GetActionRecommendationsRequest	withFilterArn(String filterArn) The ARN of the filter to apply to the returned recommendations.
GetActionRecommendationsRequest	withFilterValues(Map<String,String> filterValues) The values to use when filtering recommendations.
GetActionRecommendationsRequest	withNumResults(Integer numResults) The number of results to return.
GetActionRecommendationsRequest	withUserId(String userId) The user ID of the user to provide action recommendations for.

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

GetActionRecommendationsRequest

public GetActionRecommendationsRequest()

Method Detail

setCampaignArn

public void setCampaignArn(String campaignArn)

The Amazon Resource Name (ARN) of the campaign to use for getting action recommendations. This campaign must deploy a solution version trained with a PERSONALIZED_ACTIONS recipe.

Parameters:

campaignArn - The Amazon Resource Name (ARN) of the campaign to use for getting action recommendations. This campaign must deploy a solution version trained with a PERSONALIZED_ACTIONS recipe.

getCampaignArn

public String getCampaignArn()

The Amazon Resource Name (ARN) of the campaign to use for getting action recommendations. This campaign must deploy a solution version trained with a PERSONALIZED_ACTIONS recipe.

Returns:

The Amazon Resource Name (ARN) of the campaign to use for getting action recommendations. This campaign must deploy a solution version trained with a PERSONALIZED_ACTIONS recipe.

withCampaignArn

public GetActionRecommendationsRequest withCampaignArn(String campaignArn)

The Amazon Resource Name (ARN) of the campaign to use for getting action recommendations. This campaign must deploy a solution version trained with a PERSONALIZED_ACTIONS recipe.

Parameters:

campaignArn - The Amazon Resource Name (ARN) of the campaign to use for getting action recommendations. This campaign must deploy a solution version trained with a PERSONALIZED_ACTIONS recipe.

Returns:

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

setUserId

public void setUserId(String userId)

The user ID of the user to provide action recommendations for.

Parameters:

userId - The user ID of the user to provide action recommendations for.

getUserId

public String getUserId()

The user ID of the user to provide action recommendations for.

Returns:

The user ID of the user to provide action recommendations for.

withUserId

public GetActionRecommendationsRequest withUserId(String userId)

The user ID of the user to provide action recommendations for.

Parameters:

userId - The user ID of the user to provide action recommendations for.

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 5. The maximum is 100.

Parameters:

numResults - The number of results to return. The default is 5. The maximum is 100.

getNumResults

public Integer getNumResults()

The number of results to return. The default is 5. The maximum is 100.

Returns:

The number of results to return. The default is 5. The maximum is 100.

withNumResults

public GetActionRecommendationsRequest withNumResults(Integer numResults)

The number of results to return. The default is 5. The maximum is 100.

Parameters:

numResults - The number of results to return. The default is 5. The maximum is 100.

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 GetActionRecommendationsRequest 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 actions, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude actions, 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 actions, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude actions, 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 actions, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude actions, 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 actions, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude actions, 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 GetActionRecommendationsRequest 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 actions, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude actions, 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 actions, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude actions, 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 GetActionRecommendationsRequest addFilterValuesEntry(String key,
                                                            String value)

Add a single FilterValues entry

See Also:

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

clearFilterValuesEntries

public GetActionRecommendationsRequest clearFilterValuesEntries()

Removes all the entries added into FilterValues.

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 GetActionRecommendationsRequest 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()