Interface GetProfileRecommendationsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetProfileRecommendationsRequest.Builder,GetProfileRecommendationsRequest>, CustomerProfilesRequest.Builder, SdkBuilder<GetProfileRecommendationsRequest.Builder,GetProfileRecommendationsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetProfileRecommendationsRequest

@Mutable
@NotThreadSafe
public static interface GetProfileRecommendationsRequest.Builder
extends CustomerProfilesRequest.Builder, SdkPojo, CopyableBuilder<GetProfileRecommendationsRequest.Builder,GetProfileRecommendationsRequest>

Method Summary

Modifier and Type	Method	Description
GetProfileRecommendationsRequest.Builder	candidateIds(String... candidateIds)	A list of item IDs to rank for the user.
GetProfileRecommendationsRequest.Builder	candidateIds(Collection<String> candidateIds)	A list of item IDs to rank for the user.
GetProfileRecommendationsRequest.Builder	context(Map<String,String> context)	The contextual metadata used to provide dynamic runtime information to tailor recommendations.
default GetProfileRecommendationsRequest.Builder	diversityConfig(Consumer<RecommendationDiversityConfig.Builder> diversityConfig)	Runtime diversity configuration for this request.
GetProfileRecommendationsRequest.Builder	diversityConfig(RecommendationDiversityConfig diversityConfig)	Runtime diversity configuration for this request.
GetProfileRecommendationsRequest.Builder	domainName(String domainName)	The unique name of the domain.
GetProfileRecommendationsRequest.Builder	maxResults(Integer maxResults)	The maximum number of recommendations to return.
default GetProfileRecommendationsRequest.Builder	metadataConfig(Consumer<MetadataConfig.Builder> metadataConfig)	Configuration for including item metadata in the recommendation response.
GetProfileRecommendationsRequest.Builder	metadataConfig(MetadataConfig metadataConfig)	Configuration for including item metadata in the recommendation response.
GetProfileRecommendationsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
GetProfileRecommendationsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
GetProfileRecommendationsRequest.Builder	profileId(String profileId)	The unique identifier of the profile for which to retrieve recommendations.
GetProfileRecommendationsRequest.Builder	recommenderFilters(Collection<RecommenderFilter> recommenderFilters)	A list of filters to apply to the returned recommendations.
GetProfileRecommendationsRequest.Builder	recommenderFilters(Consumer<RecommenderFilter.Builder>... recommenderFilters)	A list of filters to apply to the returned recommendations.
GetProfileRecommendationsRequest.Builder	recommenderFilters(RecommenderFilter... recommenderFilters)	A list of filters to apply to the returned recommendations.
GetProfileRecommendationsRequest.Builder	recommenderName(String recommenderName)	The unique name of the recommender.
GetProfileRecommendationsRequest.Builder	recommenderPromotionalFilters(Collection<RecommenderPromotionalFilter> recommenderPromotionalFilters)	A list of promotional filters to apply to the recommendations.
GetProfileRecommendationsRequest.Builder	recommenderPromotionalFilters(Consumer<RecommenderPromotionalFilter.Builder>... recommenderPromotionalFilters)	A list of promotional filters to apply to the recommendations.
GetProfileRecommendationsRequest.Builder	recommenderPromotionalFilters(RecommenderPromotionalFilter... recommenderPromotionalFilters)	A list of promotional filters to apply to the recommendations.

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.customerprofiles.model.CustomerProfilesRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

domainName

GetProfileRecommendationsRequest.Builder domainName(String domainName)

The unique name of the domain.

Parameters:

domainName - The unique name of the domain.

Returns:

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

profileId

GetProfileRecommendationsRequest.Builder profileId(String profileId)

The unique identifier of the profile for which to retrieve recommendations.

Parameters:

profileId - The unique identifier of the profile for which to retrieve recommendations.

Returns:

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

recommenderName

GetProfileRecommendationsRequest.Builder recommenderName(String recommenderName)

The unique name of the recommender.

Parameters:

recommenderName - The unique name of the recommender.

Returns:

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

context

GetProfileRecommendationsRequest.Builder context(Map<String,String> context)

The contextual metadata used to provide dynamic runtime information to tailor recommendations.

Parameters:

context - The contextual metadata used to provide dynamic runtime information to tailor recommendations.

Returns:

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

recommenderFilters

GetProfileRecommendationsRequest.Builder recommenderFilters(Collection<RecommenderFilter> recommenderFilters)

A list of filters to apply to the returned recommendations. Filters define criteria for including or excluding items from the recommendation results.

Parameters:

recommenderFilters - A list of filters to apply to the returned recommendations. Filters define criteria for including or excluding items from the recommendation results.

Returns:

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

recommenderFilters

GetProfileRecommendationsRequest.Builder recommenderFilters(RecommenderFilter... recommenderFilters)

A list of filters to apply to the returned recommendations. Filters define criteria for including or excluding items from the recommendation results.

Parameters:

recommenderFilters - A list of filters to apply to the returned recommendations. Filters define criteria for including or excluding items from the recommendation results.

Returns:

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

recommenderFilters

GetProfileRecommendationsRequest.Builder recommenderFilters(Consumer<RecommenderFilter.Builder>... recommenderFilters)

A list of filters to apply to the returned recommendations. Filters define criteria for including or excluding items from the recommendation results.

This is a convenience method that creates an instance of the RecommenderFilter.Builder avoiding the need to create one manually via RecommenderFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to recommenderFilters(List<RecommenderFilter>).

Parameters:

recommenderFilters - a consumer that will call methods on RecommenderFilter.Builder

Returns:

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

See Also:

• recommenderFilters(java.util.Collection<RecommenderFilter>)

recommenderPromotionalFilters

GetProfileRecommendationsRequest.Builder recommenderPromotionalFilters(Collection<RecommenderPromotionalFilter> recommenderPromotionalFilters)

A list of promotional filters to apply to the recommendations. Promotional filters allow you to promote specific items within a configurable subset of recommendation results.

Parameters:

recommenderPromotionalFilters - A list of promotional filters to apply to the recommendations. Promotional filters allow you to promote specific items within a configurable subset of recommendation results.

Returns:

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

recommenderPromotionalFilters

GetProfileRecommendationsRequest.Builder recommenderPromotionalFilters(RecommenderPromotionalFilter... recommenderPromotionalFilters)

A list of promotional filters to apply to the recommendations. Promotional filters allow you to promote specific items within a configurable subset of recommendation results.

Parameters:

recommenderPromotionalFilters - A list of promotional filters to apply to the recommendations. Promotional filters allow you to promote specific items within a configurable subset of recommendation results.

Returns:

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

recommenderPromotionalFilters

GetProfileRecommendationsRequest.Builder recommenderPromotionalFilters(Consumer<RecommenderPromotionalFilter.Builder>... recommenderPromotionalFilters)

A list of promotional filters to apply to the recommendations. Promotional filters allow you to promote specific items within a configurable subset of recommendation results.

This is a convenience method that creates an instance of the RecommenderPromotionalFilter.Builder avoiding the need to create one manually via RecommenderPromotionalFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to recommenderPromotionalFilters(List<RecommenderPromotionalFilter>).

Parameters:

recommenderPromotionalFilters - a consumer that will call methods on RecommenderPromotionalFilter.Builder

Returns:

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

See Also:

• recommenderPromotionalFilters(java.util.Collection<RecommenderPromotionalFilter>)

candidateIds

GetProfileRecommendationsRequest.Builder candidateIds(Collection<String> candidateIds)

A list of item IDs to rank for the user. Use this when you want to re-rank a specific set of items rather than getting recommendations from the full item catalog. Required for personalized-ranking use cases.

Parameters:

candidateIds - A list of item IDs to rank for the user. Use this when you want to re-rank a specific set of items rather than getting recommendations from the full item catalog. Required for personalized-ranking use cases.

Returns:

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

candidateIds

GetProfileRecommendationsRequest.Builder candidateIds(String... candidateIds)

A list of item IDs to rank for the user. Use this when you want to re-rank a specific set of items rather than getting recommendations from the full item catalog. Required for personalized-ranking use cases.

Parameters:

candidateIds - A list of item IDs to rank for the user. Use this when you want to re-rank a specific set of items rather than getting recommendations from the full item catalog. Required for personalized-ranking use cases.

Returns:

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

maxResults

GetProfileRecommendationsRequest.Builder maxResults(Integer maxResults)

The maximum number of recommendations to return. The default value is 10.

Parameters:

maxResults - The maximum number of recommendations to return. The default value is 10.

Returns:

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

metadataConfig

GetProfileRecommendationsRequest.Builder metadataConfig(MetadataConfig metadataConfig)

Configuration for including item metadata in the recommendation response. Use this to specify which metadata columns to return alongside recommended items.

Parameters:

metadataConfig - Configuration for including item metadata in the recommendation response. Use this to specify which metadata columns to return alongside recommended items.

Returns:

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

metadataConfig

default GetProfileRecommendationsRequest.Builder metadataConfig(Consumer<MetadataConfig.Builder> metadataConfig)

Configuration for including item metadata in the recommendation response. Use this to specify which metadata columns to return alongside recommended items.

This is a convenience method that creates an instance of the MetadataConfig.Builder avoiding the need to create one manually via MetadataConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metadataConfig(MetadataConfig).

Parameters:

metadataConfig - a consumer that will call methods on MetadataConfig.Builder

Returns:

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

See Also:

• metadataConfig(MetadataConfig)

diversityConfig

GetProfileRecommendationsRequest.Builder diversityConfig(RecommendationDiversityConfig diversityConfig)

Runtime diversity configuration for this request. Enables diversity-aware recommendations and optionally supplies values for placeholder-based diversity caps configured on the recommender.

Parameters:

diversityConfig - Runtime diversity configuration for this request. Enables diversity-aware recommendations and optionally supplies values for placeholder-based diversity caps configured on the recommender.

Returns:

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

diversityConfig

default GetProfileRecommendationsRequest.Builder diversityConfig(Consumer<RecommendationDiversityConfig.Builder> diversityConfig)

Runtime diversity configuration for this request. Enables diversity-aware recommendations and optionally supplies values for placeholder-based diversity caps configured on the recommender.

This is a convenience method that creates an instance of the RecommendationDiversityConfig.Builder avoiding the need to create one manually via RecommendationDiversityConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to diversityConfig(RecommendationDiversityConfig).

Parameters:

diversityConfig - a consumer that will call methods on RecommendationDiversityConfig.Builder

Returns:

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

See Also:

• diversityConfig(RecommendationDiversityConfig)

overrideConfiguration

GetProfileRecommendationsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

GetProfileRecommendationsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.