software.amazon.awssdk.services.personalizeruntime.model

Interface GetPersonalizedRankingRequest.Builder

All Superinterfaces:

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

Enclosing class:

GetPersonalizedRankingRequest

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

Method Summary

Modifier and Type	Method and Description
GetPersonalizedRankingRequest.Builder	campaignArn(String campaignArn) The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.
GetPersonalizedRankingRequest.Builder	context(Map<String,String> context) The contextual metadata to use when getting recommendations.
GetPersonalizedRankingRequest.Builder	filterArn(String filterArn) The Amazon Resource Name (ARN) of a filter you created to include or exclude items from recommendations for a given user.
GetPersonalizedRankingRequest.Builder	inputList(Collection<String> inputList) A list of items (by itemId) to rank.
GetPersonalizedRankingRequest.Builder	inputList(String... inputList) A list of items (by itemId) to rank.
GetPersonalizedRankingRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetPersonalizedRankingRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetPersonalizedRankingRequest.Builder	userId(String userId) The user for which you want the campaign to provide a personalized ranking.

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

GetPersonalizedRankingRequest.Builder campaignArn(String campaignArn)

The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.

Parameters:

campaignArn - The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.

Returns:

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

inputList

GetPersonalizedRankingRequest.Builder inputList(Collection<String> inputList)

A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. The maximum is 500.

Parameters:

inputList - A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. The maximum is 500.

Returns:

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

inputList

GetPersonalizedRankingRequest.Builder inputList(String... inputList)

A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. The maximum is 500.

Parameters:

inputList - A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. The maximum is 500.

Returns:

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

userId

GetPersonalizedRankingRequest.Builder userId(String userId)

The user for which you want the campaign to provide a personalized ranking.

Parameters:

userId - The user for which you want the campaign to provide a personalized ranking.

Returns:

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

context

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

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.

Returns:

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

filterArn

GetPersonalizedRankingRequest.Builder filterArn(String filterArn)

The Amazon Resource Name (ARN) of a filter you created to include or exclude items from recommendations for a given user.

Parameters:

filterArn - The Amazon Resource Name (ARN) of a filter you created to include or exclude items from recommendations for a given user.

Returns:

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

overrideConfiguration

GetPersonalizedRankingRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder