/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.personalize.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* An object that provides information about a solution. A solution is a trained model that can be deployed as a * campaign. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class Solution implements Serializable, Cloneable, StructuredPojo { /** *

* The name of the solution. *

*/ private String name; /** *

* The ARN of the solution. *

*/ private String solutionArn; /** *

* Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false. *

*/ private Boolean performHPO; /** * *

* 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 (recipeArn must not be specified). When false (the default), Amazon * Personalize uses recipeArn for training. *

*/ private Boolean performAutoML; /** *

* The ARN of the recipe used to create the solution. This is required when performAutoML is false. *

*/ private String recipeArn; /** *

* The Amazon Resource Name (ARN) of the dataset group that provides the training data. *

*/ private String datasetGroupArn; /** *

* The event type (for example, 'click' or 'like') that is used for training the model. If no eventType * is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type. *

*/ private String eventType; /** *

* Describes the configuration properties for the solution. *

*/ private SolutionConfig solutionConfig; /** *

* When performAutoML is true, specifies the best recipe found. *

*/ private AutoMLResult autoMLResult; /** *

* The status of the solution. *

*

* A solution can be in one of the following states: *

* */ private String status; /** *

* The creation date and time (in Unix time) of the solution. *

*/ private java.util.Date creationDateTime; /** *

* The date and time (in Unix time) that the solution was last updated. *

*/ private java.util.Date lastUpdatedDateTime; /** *

* Describes the latest version of the solution, including the status and the ARN. *

*/ private SolutionVersionSummary latestSolutionVersion; /** *

* The name of the solution. *

* * @param name * The name of the solution. */ public void setName(String name) { this.name = name; } /** *

* The name of the solution. *

* * @return The name of the solution. */ public String getName() { return this.name; } /** *

* The name of the solution. *

* * @param name * The name of the solution. * @return Returns a reference to this object so that method calls can be chained together. */ public Solution withName(String name) { setName(name); return this; } /** *

* The ARN of the solution. *

* * @param solutionArn * The ARN of the solution. */ public void setSolutionArn(String solutionArn) { this.solutionArn = solutionArn; } /** *

* The ARN of the solution. *

* * @return The ARN of the solution. */ public String getSolutionArn() { return this.solutionArn; } /** *

* The ARN of the solution. *

* * @param solutionArn * The ARN of the solution. * @return Returns a reference to this object so that method calls can be chained together. */ public Solution withSolutionArn(String solutionArn) { setSolutionArn(solutionArn); return this; } /** *

* Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false. *

* * @param performHPO * Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is * false. */ public void setPerformHPO(Boolean performHPO) { this.performHPO = performHPO; } /** *

* Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false. *

* * @return Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is * false. */ public Boolean getPerformHPO() { return this.performHPO; } /** *

* Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false. *

* * @param performHPO * Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is * false. * @return Returns a reference to this object so that method calls can be chained together. */ public Solution withPerformHPO(Boolean performHPO) { setPerformHPO(performHPO); return this; } /** *

* Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false. *

* * @return Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is * false. */ public Boolean isPerformHPO() { return this.performHPO; } /** * *

* 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 (recipeArn must not be specified). When false (the default), Amazon * Personalize uses recipeArn for training. *

* * @param 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 (recipeArn must not be specified). When false (the * default), Amazon Personalize uses recipeArn for training. */ public void setPerformAutoML(Boolean performAutoML) { this.performAutoML = 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 (recipeArn must not be specified). When false (the default), Amazon * Personalize uses recipeArn for training. *

* * @return

* 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 (recipeArn must not be specified). When false (the * default), Amazon Personalize uses recipeArn for training. */ public Boolean getPerformAutoML() { return this.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 (recipeArn must not be specified). When false (the default), Amazon * Personalize uses recipeArn for training. *

* * @param 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 (recipeArn must not be specified). When false (the * default), Amazon Personalize uses recipeArn for training. * @return Returns a reference to this object so that method calls can be chained together. */ public Solution withPerformAutoML(Boolean performAutoML) { setPerformAutoML(performAutoML); return this; } /** * *

* 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 (recipeArn must not be specified). When false (the default), Amazon * Personalize uses recipeArn for training. *

* * @return

* 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 (recipeArn must not be specified). When false (the * default), Amazon Personalize uses recipeArn for training. */ public Boolean isPerformAutoML() { return this.performAutoML; } /** *

* The ARN of the recipe used to create the solution. This is required when performAutoML is false. *

* * @param recipeArn * The ARN of the recipe used to create the solution. This is required when performAutoML is * false. */ public void setRecipeArn(String recipeArn) { this.recipeArn = recipeArn; } /** *

* The ARN of the recipe used to create the solution. This is required when performAutoML is false. *

* * @return The ARN of the recipe used to create the solution. This is required when performAutoML is * false. */ public String getRecipeArn() { return this.recipeArn; } /** *

* The ARN of the recipe used to create the solution. This is required when performAutoML is false. *

* * @param recipeArn * The ARN of the recipe used to create the solution. This is required when performAutoML is * false. * @return Returns a reference to this object so that method calls can be chained together. */ public Solution withRecipeArn(String recipeArn) { setRecipeArn(recipeArn); return this; } /** *

* The Amazon Resource Name (ARN) of the dataset group that provides the training data. *

* * @param datasetGroupArn * The Amazon Resource Name (ARN) of the dataset group that provides the training data. */ public void setDatasetGroupArn(String datasetGroupArn) { this.datasetGroupArn = datasetGroupArn; } /** *

* The Amazon Resource Name (ARN) of the dataset group that provides the training data. *

* * @return The Amazon Resource Name (ARN) of the dataset group that provides the training data. */ public String getDatasetGroupArn() { return this.datasetGroupArn; } /** *

* The Amazon Resource Name (ARN) of the dataset group that provides the training data. *

* * @param datasetGroupArn * The Amazon Resource Name (ARN) of the dataset group that provides the training data. * @return Returns a reference to this object so that method calls can be chained together. */ public Solution withDatasetGroupArn(String datasetGroupArn) { setDatasetGroupArn(datasetGroupArn); return this; } /** *

* The event type (for example, 'click' or 'like') that is used for training the model. If no eventType * is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type. *

* * @param eventType * The event type (for example, 'click' or 'like') that is used for training the model. If no * eventType is provided, Amazon Personalize uses all interactions for training with equal * weight regardless of type. */ public void setEventType(String eventType) { this.eventType = eventType; } /** *

* The event type (for example, 'click' or 'like') that is used for training the model. If no eventType * is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type. *

* * @return The event type (for example, 'click' or 'like') that is used for training the model. If no * eventType is provided, Amazon Personalize uses all interactions for training with equal * weight regardless of type. */ public String getEventType() { return this.eventType; } /** *

* The event type (for example, 'click' or 'like') that is used for training the model. If no eventType * is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type. *

* * @param eventType * The event type (for example, 'click' or 'like') that is used for training the model. If no * eventType is provided, Amazon Personalize uses all interactions for training with equal * weight regardless of type. * @return Returns a reference to this object so that method calls can be chained together. */ public Solution withEventType(String eventType) { setEventType(eventType); return this; } /** *

* Describes the configuration properties for the solution. *

* * @param solutionConfig * Describes the configuration properties for the solution. */ public void setSolutionConfig(SolutionConfig solutionConfig) { this.solutionConfig = solutionConfig; } /** *

* Describes the configuration properties for the solution. *

* * @return Describes the configuration properties for the solution. */ public SolutionConfig getSolutionConfig() { return this.solutionConfig; } /** *

* Describes the configuration properties for the solution. *

* * @param solutionConfig * Describes the configuration properties for the solution. * @return Returns a reference to this object so that method calls can be chained together. */ public Solution withSolutionConfig(SolutionConfig solutionConfig) { setSolutionConfig(solutionConfig); return this; } /** *

* When performAutoML is true, specifies the best recipe found. *

* * @param autoMLResult * When performAutoML is true, specifies the best recipe found. */ public void setAutoMLResult(AutoMLResult autoMLResult) { this.autoMLResult = autoMLResult; } /** *

* When performAutoML is true, specifies the best recipe found. *

* * @return When performAutoML is true, specifies the best recipe found. */ public AutoMLResult getAutoMLResult() { return this.autoMLResult; } /** *

* When performAutoML is true, specifies the best recipe found. *

* * @param autoMLResult * When performAutoML is true, specifies the best recipe found. * @return Returns a reference to this object so that method calls can be chained together. */ public Solution withAutoMLResult(AutoMLResult autoMLResult) { setAutoMLResult(autoMLResult); return this; } /** *

* The status of the solution. *

*

* A solution can be in one of the following states: *

* * * @param status * The status of the solution.

*

* A solution can be in one of the following states: *

*