Interface Solution.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<Solution.Builder,Solution>,SdkBuilder<Solution.Builder,Solution>,SdkPojo
- Enclosing class:
- Solution
public static interface Solution.Builder extends SdkPojo, CopyableBuilder<Solution.Builder,Solution>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default Solution.BuilderautoMLResult(Consumer<AutoMLResult.Builder> autoMLResult)WhenperformAutoMLis true, specifies the best recipe found.Solution.BuilderautoMLResult(AutoMLResult autoMLResult)WhenperformAutoMLis true, specifies the best recipe found.Solution.BuildercreationDateTime(Instant creationDateTime)The creation date and time (in Unix time) of the solution.Solution.BuilderdatasetGroupArn(String datasetGroupArn)The Amazon Resource Name (ARN) of the dataset group that provides the training data.Solution.BuildereventType(String eventType)The event type (for example, 'click' or 'like') that is used for training the model.Solution.BuilderlastUpdatedDateTime(Instant lastUpdatedDateTime)The date and time (in Unix time) that the solution was last updated.default Solution.BuilderlatestSolutionUpdate(Consumer<SolutionUpdateSummary.Builder> latestSolutionUpdate)Provides a summary of the latest updates to the solution.Solution.BuilderlatestSolutionUpdate(SolutionUpdateSummary latestSolutionUpdate)Provides a summary of the latest updates to the solution.default Solution.BuilderlatestSolutionVersion(Consumer<SolutionVersionSummary.Builder> latestSolutionVersion)Describes the latest version of the solution, including the status and the ARN.Solution.BuilderlatestSolutionVersion(SolutionVersionSummary latestSolutionVersion)Describes the latest version of the solution, including the status and the ARN.Solution.Buildername(String name)The name of the solution.Solution.BuilderperformAutoML(Boolean performAutoML)Solution.BuilderperformAutoTraining(Boolean performAutoTraining)Specifies whether the solution automatically creates solution versions.Solution.BuilderperformHPO(Boolean performHPO)Whether to perform hyperparameter optimization (HPO) on the chosen recipe.Solution.BuilderrecipeArn(String recipeArn)The ARN of the recipe used to create the solution.Solution.BuildersolutionArn(String solutionArn)The ARN of the solution.default Solution.BuildersolutionConfig(Consumer<SolutionConfig.Builder> solutionConfig)Describes the configuration properties for the solution.Solution.BuildersolutionConfig(SolutionConfig solutionConfig)Describes the configuration properties for the solution.Solution.Builderstatus(String status)The status of the solution.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
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 Detail
-
name
Solution.Builder name(String name)
The name of the solution.
- Parameters:
name- The name of the solution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
solutionArn
Solution.Builder solutionArn(String solutionArn)
The ARN of the solution.
- Parameters:
solutionArn- The ARN of the solution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
performHPO
Solution.Builder performHPO(Boolean performHPO)
Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is
false.- Parameters:
performHPO- Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default isfalse.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
performAutoML
Solution.Builder performAutoML(Boolean performAutoML)
We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see Determining your use case.
When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration (
recipeArnmust not be specified). When false (the default), Amazon Personalize usesrecipeArnfor training.- Parameters:
performAutoML-We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see Determining your use case.
When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration (
recipeArnmust not be specified). When false (the default), Amazon Personalize usesrecipeArnfor training.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
performAutoTraining
Solution.Builder performAutoTraining(Boolean performAutoTraining)
Specifies whether the solution automatically creates solution versions. The default is
Trueand the solution automatically creates new solution versions every 7 days.For more information about auto training, see Creating and configuring a solution.
- Parameters:
performAutoTraining- Specifies whether the solution automatically creates solution versions. The default isTrueand the solution automatically creates new solution versions every 7 days.For more information about auto training, see Creating and configuring a solution.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
recipeArn
Solution.Builder recipeArn(String recipeArn)
The ARN of the recipe used to create the solution. This is required when
performAutoMLis false.- Parameters:
recipeArn- The ARN of the recipe used to create the solution. This is required whenperformAutoMLis false.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
datasetGroupArn
Solution.Builder datasetGroupArn(String datasetGroupArn)
The Amazon Resource Name (ARN) of the dataset group that provides the training data.
- Parameters:
datasetGroupArn- The Amazon Resource Name (ARN) of the dataset group that provides the training data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
eventType
Solution.Builder eventType(String eventType)
The event type (for example, 'click' or 'like') that is used for training the model. If no
eventTypeis provided, Amazon Personalize uses all interactions for training with equal weight regardless of type.- Parameters:
eventType- The event type (for example, 'click' or 'like') that is used for training the model. If noeventTypeis provided, Amazon Personalize uses all interactions for training with equal weight regardless of type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
solutionConfig
Solution.Builder solutionConfig(SolutionConfig solutionConfig)
Describes the configuration properties for the solution.
- Parameters:
solutionConfig- Describes the configuration properties for the solution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
solutionConfig
default Solution.Builder solutionConfig(Consumer<SolutionConfig.Builder> solutionConfig)
Describes the configuration properties for the solution.
This is a convenience method that creates an instance of theSolutionConfig.Builderavoiding the need to create one manually viaSolutionConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosolutionConfig(SolutionConfig).- Parameters:
solutionConfig- a consumer that will call methods onSolutionConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
solutionConfig(SolutionConfig)
-
autoMLResult
Solution.Builder autoMLResult(AutoMLResult autoMLResult)
When
performAutoMLis true, specifies the best recipe found.- Parameters:
autoMLResult- WhenperformAutoMLis true, specifies the best recipe found.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoMLResult
default Solution.Builder autoMLResult(Consumer<AutoMLResult.Builder> autoMLResult)
When
This is a convenience method that creates an instance of theperformAutoMLis true, specifies the best recipe found.AutoMLResult.Builderavoiding the need to create one manually viaAutoMLResult.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toautoMLResult(AutoMLResult).- Parameters:
autoMLResult- a consumer that will call methods onAutoMLResult.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
autoMLResult(AutoMLResult)
-
status
Solution.Builder status(String status)
The status of the solution.
A solution can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
- Parameters:
status- The status of the solution.A solution can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
creationDateTime
Solution.Builder creationDateTime(Instant creationDateTime)
The creation date and time (in Unix time) of the solution.
- Parameters:
creationDateTime- The creation date and time (in Unix time) of the solution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastUpdatedDateTime
Solution.Builder lastUpdatedDateTime(Instant lastUpdatedDateTime)
The date and time (in Unix time) that the solution was last updated.
- Parameters:
lastUpdatedDateTime- The date and time (in Unix time) that the solution was last updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
latestSolutionVersion
Solution.Builder latestSolutionVersion(SolutionVersionSummary latestSolutionVersion)
Describes the latest version of the solution, including the status and the ARN.
- Parameters:
latestSolutionVersion- Describes the latest version of the solution, including the status and the ARN.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
latestSolutionVersion
default Solution.Builder latestSolutionVersion(Consumer<SolutionVersionSummary.Builder> latestSolutionVersion)
Describes the latest version of the solution, including the status and the ARN.
This is a convenience method that creates an instance of theSolutionVersionSummary.Builderavoiding the need to create one manually viaSolutionVersionSummary.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tolatestSolutionVersion(SolutionVersionSummary).- Parameters:
latestSolutionVersion- a consumer that will call methods onSolutionVersionSummary.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
latestSolutionVersion(SolutionVersionSummary)
-
latestSolutionUpdate
Solution.Builder latestSolutionUpdate(SolutionUpdateSummary latestSolutionUpdate)
Provides a summary of the latest updates to the solution.
- Parameters:
latestSolutionUpdate- Provides a summary of the latest updates to the solution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
latestSolutionUpdate
default Solution.Builder latestSolutionUpdate(Consumer<SolutionUpdateSummary.Builder> latestSolutionUpdate)
Provides a summary of the latest updates to the solution.
This is a convenience method that creates an instance of theSolutionUpdateSummary.Builderavoiding the need to create one manually viaSolutionUpdateSummary.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tolatestSolutionUpdate(SolutionUpdateSummary).- Parameters:
latestSolutionUpdate- a consumer that will call methods onSolutionUpdateSummary.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
latestSolutionUpdate(SolutionUpdateSummary)
-
-