software.amazon.awssdk.services.personalize.model

Interface Recommender.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Recommender.Builder,Recommender>, SdkBuilder<Recommender.Builder,Recommender>, SdkPojo

Enclosing class:

Recommender

public static interface Recommender.Builder
extends SdkPojo, CopyableBuilder<Recommender.Builder,Recommender>

Method Summary

Modifier and Type	Method and Description
Recommender.Builder	creationDateTime(Instant creationDateTime) The date and time (in Unix format) that the recommender was created.
Recommender.Builder	datasetGroupArn(String datasetGroupArn) The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
Recommender.Builder	failureReason(String failureReason) If a recommender fails, the reason behind the failure.
Recommender.Builder	lastUpdatedDateTime(Instant lastUpdatedDateTime) The date and time (in Unix format) that the recommender was last updated.
default Recommender.Builder	latestRecommenderUpdate(Consumer<RecommenderUpdateSummary.Builder> latestRecommenderUpdate) Provides a summary of the latest updates to the recommender.
Recommender.Builder	latestRecommenderUpdate(RecommenderUpdateSummary latestRecommenderUpdate) Provides a summary of the latest updates to the recommender.
Recommender.Builder	modelMetrics(Map<String,Double> modelMetrics) Provides evaluation metrics that help you determine the performance of a recommender.
Recommender.Builder	name(String name) The name of the recommender.
Recommender.Builder	recipeArn(String recipeArn) The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
Recommender.Builder	recommenderArn(String recommenderArn) The Amazon Resource Name (ARN) of the recommender.
default Recommender.Builder	recommenderConfig(Consumer<RecommenderConfig.Builder> recommenderConfig) The configuration details of the recommender.
Recommender.Builder	recommenderConfig(RecommenderConfig recommenderConfig) The configuration details of the recommender.
Recommender.Builder	status(String status) The status of the recommender.

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

recommenderArn

Recommender.Builder recommenderArn(String recommenderArn)

The Amazon Resource Name (ARN) of the recommender.

Parameters:

recommenderArn - The Amazon Resource Name (ARN) of the recommender.

Returns:

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

datasetGroupArn

Recommender.Builder datasetGroupArn(String datasetGroupArn)

The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.

Parameters:

datasetGroupArn - The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.

Returns:

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

name

Recommender.Builder name(String name)

The name of the recommender.

Parameters:

name - The name of the recommender.

Returns:

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

recipeArn

Recommender.Builder recipeArn(String recipeArn)

The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.

Parameters:

recipeArn - The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.

Returns:

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

recommenderConfig

Recommender.Builder recommenderConfig(RecommenderConfig recommenderConfig)

The configuration details of the recommender.

Parameters:

recommenderConfig - The configuration details of the recommender.

Returns:

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

recommenderConfig

default Recommender.Builder recommenderConfig(Consumer<RecommenderConfig.Builder> recommenderConfig)

The configuration details of the recommender.

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

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

Parameters:

recommenderConfig - a consumer that will call methods on RecommenderConfig.Builder

Returns:

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

See Also:

recommenderConfig(RecommenderConfig)

creationDateTime

Recommender.Builder creationDateTime(Instant creationDateTime)

The date and time (in Unix format) that the recommender was created.

Parameters:

creationDateTime - The date and time (in Unix format) that the recommender was created.

Returns:

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

lastUpdatedDateTime

Recommender.Builder lastUpdatedDateTime(Instant lastUpdatedDateTime)

The date and time (in Unix format) that the recommender was last updated.

Parameters:

lastUpdatedDateTime - The date and time (in Unix format) that the recommender was last updated.

Returns:

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

status

Recommender.Builder status(String status)

The status of the recommender.

A recommender can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

• STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE

• DELETE PENDING > DELETE IN_PROGRESS

Parameters:

status - The status of the recommender.

A recommender can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

• STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE

• DELETE PENDING > DELETE IN_PROGRESS

Returns:

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

failureReason

Recommender.Builder failureReason(String failureReason)

If a recommender fails, the reason behind the failure.

Parameters:

failureReason - If a recommender fails, the reason behind the failure.

Returns:

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

latestRecommenderUpdate

Recommender.Builder latestRecommenderUpdate(RecommenderUpdateSummary latestRecommenderUpdate)

Provides a summary of the latest updates to the recommender.

Parameters:

latestRecommenderUpdate - Provides a summary of the latest updates to the recommender.

Returns:

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

latestRecommenderUpdate

default Recommender.Builder latestRecommenderUpdate(Consumer<RecommenderUpdateSummary.Builder> latestRecommenderUpdate)

Provides a summary of the latest updates to the recommender.

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

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

Parameters:

latestRecommenderUpdate - a consumer that will call methods on RecommenderUpdateSummary.Builder

Returns:

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

See Also:

latestRecommenderUpdate(RecommenderUpdateSummary)

modelMetrics

Recommender.Builder modelMetrics(Map<String,Double> modelMetrics)

Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a recommender.

Parameters:

modelMetrics - Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a recommender.

Returns:

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