/* * 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.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateSolutionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The name for the solution. *
*/ private String name; /** *
* Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is
* false
.
*
* When performing AutoML, this parameter is always true
and you should not set it to
* false
.
*
* 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. *
*
* Whether to perform automated machine learning (AutoML). The default is false
. For this case, you
* must specify recipeArn
.
*
* When set to true
, Amazon Personalize analyzes your training data and selects the optimal
* USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn
. Amazon
* Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML
* lengthens the training process as compared to selecting a specific recipe.
*
* The ARN of the recipe to use for model training. This is required when performAutoML
is false.
*
* The Amazon Resource Name (ARN) of the dataset group that provides the training data. *
*/ private String datasetGroupArn; /** *
* When your have multiple event types (using an EVENT_TYPE
schema field), this parameter specifies
* which event type (for example, 'click' or 'like') is used for training the model.
*
* If you do not provide an eventType
, Amazon Personalize will use all interactions for training with
* equal weight regardless of type.
*
* The configuration to use with the solution. When performAutoML
is set to true, Amazon Personalize
* only evaluates the autoMLConfig
section of the solution configuration.
*
* Amazon Personalize doesn't support configuring the hpoObjective
at this time.
*
* A list of tags to apply to * the solution. *
*/ private java.util.List* The name for the solution. *
* * @param name * The name for the solution. */ public void setName(String name) { this.name = name; } /** ** The name for the solution. *
* * @return The name for the solution. */ public String getName() { return this.name; } /** ** The name for the solution. *
* * @param name * The name for the solution. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateSolutionRequest withName(String name) { setName(name); return this; } /** *
* Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is
* false
.
*
* When performing AutoML, this parameter is always true
and you should not set it to
* false
.
*
false
.
*
* When performing AutoML, this parameter is always true
and you should not set it to
* false
.
*/
public void setPerformHPO(Boolean performHPO) {
this.performHPO = performHPO;
}
/**
*
* Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is
* false
.
*
* When performing AutoML, this parameter is always true
and you should not set it to
* false
.
*
false
.
*
* When performing AutoML, this parameter is always true
and you should not set it to
* false
.
*/
public Boolean getPerformHPO() {
return this.performHPO;
}
/**
*
* Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is
* false
.
*
* When performing AutoML, this parameter is always true
and you should not set it to
* false
.
*
false
.
*
* When performing AutoML, this parameter is always true
and you should not set it to
* false
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateSolutionRequest withPerformHPO(Boolean performHPO) {
setPerformHPO(performHPO);
return this;
}
/**
*
* Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is
* false
.
*
* When performing AutoML, this parameter is always true
and you should not set it to
* false
.
*
false
.
*
* When performing AutoML, this parameter is always
* 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.
* true
and you should not set it to
* false
.
*/
public Boolean isPerformHPO() {
return this.performHPO;
}
/**
*
* Whether to perform automated machine learning (AutoML). The default is false
. For this case, you
* must specify recipeArn
.
*
* When set to true
, Amazon Personalize analyzes your training data and selects the optimal
* USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn
. Amazon
* Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML
* lengthens the training process as compared to selecting a specific recipe.
*
* 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. *
* *
* Whether to perform automated machine learning (AutoML). The default is false
. For this case,
* you must specify recipeArn
.
*
* When set to
* 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.
* true
, Amazon Personalize analyzes your training data and selects the optimal
* USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn
.
* Amazon Personalize determines the optimal recipe by running tests with different values for the
* hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.
*/
public void setPerformAutoML(Boolean performAutoML) {
this.performAutoML = performAutoML;
}
/**
*
* Whether to perform automated machine learning (AutoML). The default is false
. For this case, you
* must specify recipeArn
.
*
* When set to true
, Amazon Personalize analyzes your training data and selects the optimal
* USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn
. Amazon
* Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML
* lengthens the training process as compared to selecting a specific recipe.
*
* 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. *
* *
* Whether to perform automated machine learning (AutoML). The default is false
. For this case,
* you must specify recipeArn
.
*
* When set to
* 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.
* true
, Amazon Personalize analyzes your training data and selects the optimal
* USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn
.
* Amazon Personalize determines the optimal recipe by running tests with different values for the
* hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.
*/
public Boolean getPerformAutoML() {
return this.performAutoML;
}
/**
*
* Whether to perform automated machine learning (AutoML). The default is false
. For this case, you
* must specify recipeArn
.
*
* When set to true
, Amazon Personalize analyzes your training data and selects the optimal
* USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn
. Amazon
* Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML
* lengthens the training process as compared to selecting a specific recipe.
*
* 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. *
* *
* Whether to perform automated machine learning (AutoML). The default is false
. For this case,
* you must specify recipeArn
.
*
* When set to
* 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.
* true
, Amazon Personalize analyzes your training data and selects the optimal
* USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn
.
* Amazon Personalize determines the optimal recipe by running tests with different values for the
* hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateSolutionRequest withPerformAutoML(Boolean performAutoML) {
setPerformAutoML(performAutoML);
return this;
}
/**
*
* Whether to perform automated machine learning (AutoML). The default is false
. For this case, you
* must specify recipeArn
.
*
* When set to true
, Amazon Personalize analyzes your training data and selects the optimal
* USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn
. Amazon
* Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML
* lengthens the training process as compared to selecting a specific recipe.
*
* 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. *
* *
* Whether to perform automated machine learning (AutoML). The default is false
. For this case,
* you must specify recipeArn
.
*
* When set to true
, Amazon Personalize analyzes your training data and selects the optimal
* USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn
.
* Amazon Personalize determines the optimal recipe by running tests with different values for the
* hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.
*/
public Boolean isPerformAutoML() {
return this.performAutoML;
}
/**
*
* The ARN of the recipe to use for model training. This is required when performAutoML
is false.
*
performAutoML
is
* false.
*/
public void setRecipeArn(String recipeArn) {
this.recipeArn = recipeArn;
}
/**
*
* The ARN of the recipe to use for model training. This is required when performAutoML
is false.
*
performAutoML
is
* false.
*/
public String getRecipeArn() {
return this.recipeArn;
}
/**
*
* The ARN of the recipe to use for model training. This is required when performAutoML
is false.
*
performAutoML
is
* false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateSolutionRequest 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 CreateSolutionRequest withDatasetGroupArn(String datasetGroupArn) { setDatasetGroupArn(datasetGroupArn); return this; } /** *
* When your have multiple event types (using an EVENT_TYPE
schema field), this parameter specifies
* which event type (for example, 'click' or 'like') is used for training the model.
*
* If you do not provide an eventType
, Amazon Personalize will use all interactions for training with
* equal weight regardless of type.
*
EVENT_TYPE
schema field), this parameter
* specifies which event type (for example, 'click' or 'like') is used for training the model.
*
* If you do not provide an eventType
, Amazon Personalize will use all interactions for training
* with equal weight regardless of type.
*/
public void setEventType(String eventType) {
this.eventType = eventType;
}
/**
*
* When your have multiple event types (using an EVENT_TYPE
schema field), this parameter specifies
* which event type (for example, 'click' or 'like') is used for training the model.
*
* If you do not provide an eventType
, Amazon Personalize will use all interactions for training with
* equal weight regardless of type.
*
EVENT_TYPE
schema field), this parameter
* specifies which event type (for example, 'click' or 'like') is used for training the model.
*
* If you do not provide an eventType
, Amazon Personalize will use all interactions for
* training with equal weight regardless of type.
*/
public String getEventType() {
return this.eventType;
}
/**
*
* When your have multiple event types (using an EVENT_TYPE
schema field), this parameter specifies
* which event type (for example, 'click' or 'like') is used for training the model.
*
* If you do not provide an eventType
, Amazon Personalize will use all interactions for training with
* equal weight regardless of type.
*
EVENT_TYPE
schema field), this parameter
* specifies which event type (for example, 'click' or 'like') is used for training the model.
*
* If you do not provide an eventType
, Amazon Personalize will use 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 CreateSolutionRequest withEventType(String eventType) {
setEventType(eventType);
return this;
}
/**
*
* The configuration to use with the solution. When performAutoML
is set to true, Amazon Personalize
* only evaluates the autoMLConfig
section of the solution configuration.
*
* Amazon Personalize doesn't support configuring the hpoObjective
at this time.
*
performAutoML
is set to true, Amazon
* Personalize only evaluates the autoMLConfig
section of the solution configuration.
* Amazon Personalize doesn't support configuring the hpoObjective
at this time.
*
* The configuration to use with the solution. When performAutoML
is set to true, Amazon Personalize
* only evaluates the autoMLConfig
section of the solution configuration.
*
* Amazon Personalize doesn't support configuring the hpoObjective
at this time.
*
performAutoML
is set to true, Amazon
* Personalize only evaluates the autoMLConfig
section of the solution configuration.
*
* Amazon Personalize doesn't support configuring the hpoObjective
at this time.
*
* The configuration to use with the solution. When performAutoML
is set to true, Amazon Personalize
* only evaluates the autoMLConfig
section of the solution configuration.
*
* Amazon Personalize doesn't support configuring the hpoObjective
at this time.
*
performAutoML
is set to true, Amazon
* Personalize only evaluates the autoMLConfig
section of the solution configuration.
* Amazon Personalize doesn't support configuring the hpoObjective
at this time.
*
* A list of tags to apply to * the solution. *
* * @return A list of tags to * apply to the solution. */ public java.util.List* A list of tags to apply to * the solution. *
* * @param tags * A list of tags to * apply to the solution. */ public void setTags(java.util.Collection* A list of tags to apply to * the solution. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the * existing values. *
* * @param tags * A list of tags to * apply to the solution. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateSolutionRequest withTags(Tag... tags) { if (this.tags == null) { setTags(new java.util.ArrayList* A list of tags to apply to * the solution. *
* * @param tags * A list of tags to * apply to the solution. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateSolutionRequest withTags(java.util.Collection