Solution (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.personalize.model.Solution

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Solution
extends Object
implements Serializable, Cloneable, StructuredPojo
```
After you create a solution, you can’t change its configuration. By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. You can't stop automatic training for a solution. To avoid unnecessary costs, make sure to delete the solution when you are finished. For information about training costs, see Amazon Personalize pricing.

An object that provides information about a solution. A solution includes the custom recipe, customized parameters, and trained models (Solution Versions) that Amazon Personalize uses to generate recommendations.

After you create a solution, you can’t change its configuration. If you need to make changes, you can clone the solution with the Amazon Personalize console or create a new one.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Solution()

Constructors
Constructor and Description
`Solution()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Solution`	`clone()`
`boolean`	`equals(Object obj)`
`AutoMLResult`	`getAutoMLResult()` When `performAutoML` is true, specifies the best recipe found.
`Date`	`getCreationDateTime()` The creation date and time (in Unix time) of the solution.
`String`	`getDatasetGroupArn()` The Amazon Resource Name (ARN) of the dataset group that provides the training data.
`String`	`getEventType()` The event type (for example, 'click' or 'like') that is used for training the model.
`Date`	`getLastUpdatedDateTime()` The date and time (in Unix time) that the solution was last updated.
`SolutionVersionSummary`	`getLatestSolutionVersion()` Describes the latest version of the solution, including the status and the ARN.
`String`	`getName()` The name of the solution.
`Boolean`	`getPerformAutoML()`
`Boolean`	`getPerformAutoTraining()` Specifies whether the solution automatically creates solution versions.
`Boolean`	`getPerformHPO()` Whether to perform hyperparameter optimization (HPO) on the chosen recipe.
`String`	`getRecipeArn()` The ARN of the recipe used to create the solution.
`String`	`getSolutionArn()` The ARN of the solution.
`SolutionConfig`	`getSolutionConfig()` Describes the configuration properties for the solution.
`String`	`getStatus()` The status of the solution.
`int`	`hashCode()`
`Boolean`	`isPerformAutoML()`
`Boolean`	`isPerformAutoTraining()` Specifies whether the solution automatically creates solution versions.
`Boolean`	`isPerformHPO()` Whether to perform hyperparameter optimization (HPO) on the chosen recipe.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAutoMLResult(AutoMLResult autoMLResult)` When `performAutoML` is true, specifies the best recipe found.
`void`	`setCreationDateTime(Date creationDateTime)` The creation date and time (in Unix time) of the solution.
`void`	`setDatasetGroupArn(String datasetGroupArn)` The Amazon Resource Name (ARN) of the dataset group that provides the training data.
`void`	`setEventType(String eventType)` The event type (for example, 'click' or 'like') that is used for training the model.
`void`	`setLastUpdatedDateTime(Date lastUpdatedDateTime)` The date and time (in Unix time) that the solution was last updated.
`void`	`setLatestSolutionVersion(SolutionVersionSummary latestSolutionVersion)` Describes the latest version of the solution, including the status and the ARN.
`void`	`setName(String name)` The name of the solution.
`void`	`setPerformAutoML(Boolean performAutoML)`
`void`	`setPerformAutoTraining(Boolean performAutoTraining)` Specifies whether the solution automatically creates solution versions.
`void`	`setPerformHPO(Boolean performHPO)` Whether to perform hyperparameter optimization (HPO) on the chosen recipe.
`void`	`setRecipeArn(String recipeArn)` The ARN of the recipe used to create the solution.
`void`	`setSolutionArn(String solutionArn)` The ARN of the solution.
`void`	`setSolutionConfig(SolutionConfig solutionConfig)` Describes the configuration properties for the solution.
`void`	`setStatus(String status)` The status of the solution.
`String`	`toString()` Returns a string representation of this object.
`Solution`	`withAutoMLResult(AutoMLResult autoMLResult)` When `performAutoML` is true, specifies the best recipe found.
`Solution`	`withCreationDateTime(Date creationDateTime)` The creation date and time (in Unix time) of the solution.
`Solution`	`withDatasetGroupArn(String datasetGroupArn)` The Amazon Resource Name (ARN) of the dataset group that provides the training data.
`Solution`	`withEventType(String eventType)` The event type (for example, 'click' or 'like') that is used for training the model.
`Solution`	`withLastUpdatedDateTime(Date lastUpdatedDateTime)` The date and time (in Unix time) that the solution was last updated.
`Solution`	`withLatestSolutionVersion(SolutionVersionSummary latestSolutionVersion)` Describes the latest version of the solution, including the status and the ARN.
`Solution`	`withName(String name)` The name of the solution.
`Solution`	`withPerformAutoML(Boolean performAutoML)`
`Solution`	`withPerformAutoTraining(Boolean performAutoTraining)` Specifies whether the solution automatically creates solution versions.
`Solution`	`withPerformHPO(Boolean performHPO)` Whether to perform hyperparameter optimization (HPO) on the chosen recipe.
`Solution`	`withRecipeArn(String recipeArn)` The ARN of the recipe used to create the solution.
`Solution`	`withSolutionArn(String solutionArn)` The ARN of the solution.
`Solution`	`withSolutionConfig(SolutionConfig solutionConfig)` Describes the configuration properties for the solution.
`Solution`	`withStatus(String status)` The status of the solution.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Solution
```
public Solution()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the solution.
    
    Parameters:
    
    name - The name of the solution.
  - getName
```
public String getName()
```
    The name of the solution.
    
    Returns:
    
    The name of the solution.
  - withName
```
public Solution withName(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.
  - setSolutionArn
```
public void setSolutionArn(String solutionArn)
```
    The ARN of the solution.
    
    Parameters:
    
    solutionArn - The ARN of the solution.
  - getSolutionArn
```
public String getSolutionArn()
```
    The ARN of the solution.
    
    Returns:
    
    The ARN of the solution.
  - withSolutionArn
```
public Solution withSolutionArn(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.
  - setPerformHPO
```
public void setPerformHPO(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 is false.
  - getPerformHPO
```
public Boolean getPerformHPO()
```
    Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.
    
    Returns:
    
    Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.
  - withPerformHPO
```
public Solution withPerformHPO(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 is false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isPerformHPO
```
public Boolean isPerformHPO()
```
    Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.
    
    Returns:
    
    Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.
  - setPerformAutoML
```
public void setPerformAutoML(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 (recipeArn must not be specified). When false (the default), Amazon Personalize uses recipeArn for 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 (recipeArn must not be specified). When false (the default), Amazon Personalize uses recipeArn for training.
  - getPerformAutoML
```
public Boolean getPerformAutoML()
```
    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.
    
    Returns:
    
    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.
  - withPerformAutoML
```
public Solution withPerformAutoML(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 (recipeArn must not be specified). When false (the default), Amazon Personalize uses recipeArn for 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 (recipeArn must not be specified). When false (the default), Amazon Personalize uses recipeArn for training.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isPerformAutoML
```
public Boolean isPerformAutoML()
```
    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.
    
    Returns:
    
    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.
  - setPerformAutoTraining
```
public void setPerformAutoTraining(Boolean performAutoTraining)
```
    Specifies whether the solution automatically creates solution versions. The default is True and 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 is True and the solution automatically creates new solution versions every 7 days.
    
    For more information about auto training, see Creating and configuring a solution.
  - getPerformAutoTraining
```
public Boolean getPerformAutoTraining()
```
    Specifies whether the solution automatically creates solution versions. The default is True and the solution automatically creates new solution versions every 7 days.
    
    For more information about auto training, see Creating and configuring a solution.
    
    Returns:
    
    Specifies whether the solution automatically creates solution versions. The default is True and the solution automatically creates new solution versions every 7 days.
    
    For more information about auto training, see Creating and configuring a solution.
  - withPerformAutoTraining
```
public Solution withPerformAutoTraining(Boolean performAutoTraining)
```
    Specifies whether the solution automatically creates solution versions. The default is True and 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 is True and 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.
  - isPerformAutoTraining
```
public Boolean isPerformAutoTraining()
```
    Specifies whether the solution automatically creates solution versions. The default is True and the solution automatically creates new solution versions every 7 days.
    
    For more information about auto training, see Creating and configuring a solution.
    
    Returns:
    
    Specifies whether the solution automatically creates solution versions. The default is True and the solution automatically creates new solution versions every 7 days.
    
    For more information about auto training, see Creating and configuring a solution.
  - setRecipeArn
```
public void setRecipeArn(String recipeArn)
```
    The ARN of the recipe used to create the solution. This is required when performAutoML is false.
    
    Parameters:
    
    recipeArn - The ARN of the recipe used to create the solution. This is required when performAutoML is false.
  - getRecipeArn
```
public String getRecipeArn()
```
    The ARN of the recipe used to create the solution. This is required when performAutoML is false.
    
    Returns:
    
    The ARN of the recipe used to create the solution. This is required when performAutoML is false.
  - withRecipeArn
```
public Solution withRecipeArn(String recipeArn)
```
    The ARN of the recipe used to create the solution. This is required when performAutoML is false.
    
    Parameters:
    
    recipeArn - The ARN of the recipe used to create the solution. This is required when performAutoML is false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDatasetGroupArn
```
public void setDatasetGroupArn(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.
  - getDatasetGroupArn
```
public String getDatasetGroupArn()
```
    The Amazon Resource Name (ARN) of the dataset group that provides the training data.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the dataset group that provides the training data.
  - withDatasetGroupArn
```
public Solution withDatasetGroupArn(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.
  - setEventType
```
public void setEventType(String 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.
    
    Parameters:
    
    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.
  - getEventType
```
public String getEventType()
```
    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.
    
    Returns:
    
    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.
  - withEventType
```
public Solution withEventType(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSolutionConfig
```
public void setSolutionConfig(SolutionConfig solutionConfig)
```
    Describes the configuration properties for the solution.
    
    Parameters:
    
    solutionConfig - Describes the configuration properties for the solution.
  - getSolutionConfig
```
public SolutionConfig getSolutionConfig()
```
    Describes the configuration properties for the solution.
    
    Returns:
    
    Describes the configuration properties for the solution.
  - withSolutionConfig
```
public Solution withSolutionConfig(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.
  - setAutoMLResult
```
public void setAutoMLResult(AutoMLResult autoMLResult)
```
    When performAutoML is true, specifies the best recipe found.
    
    Parameters:
    
    autoMLResult - When performAutoML is true, specifies the best recipe found.
  - getAutoMLResult
```
public AutoMLResult getAutoMLResult()
```
    When performAutoML is true, specifies the best recipe found.
    
    Returns:
    
    When performAutoML is true, specifies the best recipe found.
  - withAutoMLResult
```
public Solution withAutoMLResult(AutoMLResult autoMLResult)
```
    When performAutoML is true, specifies the best recipe found.
    
    Parameters:
    
    autoMLResult - When performAutoML is true, specifies the best recipe found.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(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
  - getStatus
```
public String getStatus()
```
    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:
    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
  - withStatus
```
public Solution withStatus(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.
  - setCreationDateTime
```
public void setCreationDateTime(Date 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.
  - getCreationDateTime
```
public Date getCreationDateTime()
```
    The creation date and time (in Unix time) of the solution.
    
    Returns:
    
    The creation date and time (in Unix time) of the solution.
  - withCreationDateTime
```
public Solution withCreationDateTime(Date 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.
  - setLastUpdatedDateTime
```
public void setLastUpdatedDateTime(Date 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.
  - getLastUpdatedDateTime
```
public Date getLastUpdatedDateTime()
```
    The date and time (in Unix time) that the solution was last updated.
    
    Returns:
    
    The date and time (in Unix time) that the solution was last updated.
  - withLastUpdatedDateTime
```
public Solution withLastUpdatedDateTime(Date 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.
  - setLatestSolutionVersion
```
public void setLatestSolutionVersion(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.
  - getLatestSolutionVersion
```
public SolutionVersionSummary getLatestSolutionVersion()
```
    Describes the latest version of the solution, including the status and the ARN.
    
    Returns:
    
    Describes the latest version of the solution, including the status and the ARN.
  - withLatestSolutionVersion
```
public Solution withLatestSolutionVersion(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.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Solution clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class Solution

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Solution

Method Detail

setName

getName

withName

setSolutionArn

getSolutionArn

withSolutionArn

setPerformHPO

getPerformHPO

withPerformHPO

isPerformHPO

setPerformAutoML

getPerformAutoML

withPerformAutoML

isPerformAutoML

setPerformAutoTraining

getPerformAutoTraining

withPerformAutoTraining

isPerformAutoTraining

setRecipeArn

getRecipeArn

withRecipeArn

setDatasetGroupArn

getDatasetGroupArn

withDatasetGroupArn

setEventType

getEventType

withEventType

setSolutionConfig

getSolutionConfig

withSolutionConfig

setAutoMLResult

getAutoMLResult

withAutoMLResult

setStatus

getStatus

withStatus

setCreationDateTime

getCreationDateTime

withCreationDateTime

setLastUpdatedDateTime

getLastUpdatedDateTime

withLastUpdatedDateTime

setLatestSolutionVersion

getLatestSolutionVersion

withLatestSolutionVersion

toString

equals

hashCode

clone

marshall