Interface SearchRecommendationsRequest.Builder

All Superinterfaces:

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

Enclosing class:

SearchRecommendationsRequest

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

Method Summary

Modifier and Type	Method	Description
SearchRecommendationsRequest.Builder	candidateIds(String... candidateIds)	A list of item IDs to rank for the user.
SearchRecommendationsRequest.Builder	candidateIds(Collection<String> candidateIds)	A list of item IDs to rank for the user.
SearchRecommendationsRequest.Builder	context(Map<String,String> context)	The contextual metadata used to provide dynamic runtime information to tailor recommendations.
default SearchRecommendationsRequest.Builder	diversity(Consumer<RecommendationDiversityConfig.Builder> diversity)	Runtime diversity configuration for this request.
SearchRecommendationsRequest.Builder	diversity(RecommendationDiversityConfig diversity)	Runtime diversity configuration for this request.
SearchRecommendationsRequest.Builder	domainName(String domainName)	The unique name of the domain.
SearchRecommendationsRequest.Builder	keyName(String keyName)	A searchable identifier of a customer profile.
SearchRecommendationsRequest.Builder	keyValues(String... keyValues)	A list of key values.
SearchRecommendationsRequest.Builder	keyValues(Collection<String> keyValues)	A list of key values.
SearchRecommendationsRequest.Builder	maxRecommendations(Integer maxRecommendations)	The maximum number of recommendations to return.
default SearchRecommendationsRequest.Builder	metadata(Consumer<RecommendationMetadata.Builder> metadata)	Configuration for metadata to include in recommendation responses.
SearchRecommendationsRequest.Builder	metadata(RecommendationMetadata metadata)	Configuration for metadata to include in recommendation responses.
SearchRecommendationsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SearchRecommendationsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default SearchRecommendationsRequest.Builder	recommender(Consumer<Recommender.Builder> recommender)	The recommender used to generate the recommendations.
SearchRecommendationsRequest.Builder	recommender(Recommender recommender)	The recommender used to generate 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

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

keyName

SearchRecommendationsRequest.Builder keyName(String keyName)

A searchable identifier of a customer profile. You can use a predefined key, such as _profileId, _phone, or _email, or a custom-defined key.

Parameters:

keyName - A searchable identifier of a customer profile. You can use a predefined key, such as _profileId, _phone, or _email, or a custom-defined key.

Returns:

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

keyValues

SearchRecommendationsRequest.Builder keyValues(Collection<String> keyValues)

A list of key values. Provide one value for each field of the search key.

Parameters:

keyValues - A list of key values. Provide one value for each field of the search key.

Returns:

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

keyValues

SearchRecommendationsRequest.Builder keyValues(String... keyValues)

A list of key values. Provide one value for each field of the search key.

Parameters:

keyValues - A list of key values. Provide one value for each field of the search key.

Returns:

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

recommender

SearchRecommendationsRequest.Builder recommender(Recommender recommender)

The recommender used to generate the recommendations.

Parameters:

recommender - The recommender used to generate the recommendations.

Returns:

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

recommender

default SearchRecommendationsRequest.Builder recommender(Consumer<Recommender.Builder> recommender)

The recommender used to generate the recommendations.

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

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

Parameters:

recommender - a consumer that will call methods on Recommender.Builder

Returns:

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

See Also:

• recommender(Recommender)

candidateIds

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

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

context

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

diversity

SearchRecommendationsRequest.Builder diversity(RecommendationDiversityConfig diversity)

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

Parameters:

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

diversity

default SearchRecommendationsRequest.Builder diversity(Consumer<RecommendationDiversityConfig.Builder> diversity)

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 diversity(RecommendationDiversityConfig).

Parameters:

diversity - 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:

• diversity(RecommendationDiversityConfig)

metadata

SearchRecommendationsRequest.Builder metadata(RecommendationMetadata metadata)

Configuration for metadata to include in recommendation responses.

Parameters:

metadata - Configuration for metadata to include in recommendation responses.

Returns:

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

metadata

default SearchRecommendationsRequest.Builder metadata(Consumer<RecommendationMetadata.Builder> metadata)

Configuration for metadata to include in recommendation responses.

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

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

Parameters:

metadata - a consumer that will call methods on RecommendationMetadata.Builder

Returns:

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

See Also:

• metadata(RecommendationMetadata)

maxRecommendations

SearchRecommendationsRequest.Builder maxRecommendations(Integer maxRecommendations)

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

Parameters:

maxRecommendations - The maximum number of recommendations to return. The default value is 5.

Returns:

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

overrideConfiguration

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

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