software.amazon.awssdk.services.personalizeruntime.model

Interface GetRecommendationsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetRecommendationsRequest.Builder,GetRecommendationsRequest>, PersonalizeRuntimeRequest.Builder, SdkBuilder<GetRecommendationsRequest.Builder,GetRecommendationsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetRecommendationsRequest

public static interface GetRecommendationsRequest.Builder
extends PersonalizeRuntimeRequest.Builder, SdkPojo, CopyableBuilder<GetRecommendationsRequest.Builder,GetRecommendationsRequest>

Method Summary

Modifier and Type	Method and Description
GetRecommendationsRequest.Builder	campaignArn(String campaignArn) The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
GetRecommendationsRequest.Builder	context(Map<String,String> context) The contextual metadata to use when getting recommendations.
GetRecommendationsRequest.Builder	itemId(String itemId) The item ID to provide recommendations for.
GetRecommendationsRequest.Builder	numResults(Integer numResults) The number of results to return.
GetRecommendationsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetRecommendationsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetRecommendationsRequest.Builder	userId(String userId) The user ID to provide recommendations for.

Methods inherited from interface software.amazon.awssdk.services.personalizeruntime.model.PersonalizeRuntimeRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

campaignArn

GetRecommendationsRequest.Builder campaignArn(String campaignArn)

The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

Parameters:

campaignArn - The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

Returns:

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

itemId

GetRecommendationsRequest.Builder itemId(String itemId)

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

Parameters:

itemId - The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

Returns:

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

userId

GetRecommendationsRequest.Builder userId(String userId)

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

Parameters:

userId - The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

Returns:

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

numResults

GetRecommendationsRequest.Builder numResults(Integer numResults)

The number of results to return. The default is 25. The maximum is 500.

Parameters:

numResults - The number of results to return. The default is 25. The maximum is 500.

Returns:

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

context

GetRecommendationsRequest.Builder context(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. For more information, see Contextual Metadata.

Parameters:

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. For more information, see Contextual Metadata.

Returns:

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

overrideConfiguration

GetRecommendationsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder