Interface GetActionRecommendationsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetActionRecommendationsRequest.Builder,
,GetActionRecommendationsRequest> PersonalizeRuntimeRequest.Builder
,SdkBuilder<GetActionRecommendationsRequest.Builder,
,GetActionRecommendationsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetActionRecommendationsRequest
-
Method Summary
Modifier and TypeMethodDescriptioncampaignArn
(String campaignArn) The Amazon Resource Name (ARN) of the campaign to use for getting action recommendations.The ARN of the filter to apply to the returned recommendations.filterValues
(Map<String, String> filterValues) The values to use when filtering recommendations.numResults
(Integer numResults) The number of results to return.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The user ID of the user to provide action recommendations for.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.personalizeruntime.model.PersonalizeRuntimeRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
-
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.
-
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.
-
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.
-
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 anEXCLUDE
element to exclude actions, you can omit thefilter-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 anEXCLUDE
element to exclude actions, you can omit thefilter-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.
-
overrideConfiguration
GetActionRecommendationsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetActionRecommendationsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-