Class SolutionVersion
- java.lang.Object
-
- software.amazon.awssdk.services.personalize.model.SolutionVersion
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<SolutionVersion.Builder,SolutionVersion>
@Generated("software.amazon.awssdk:codegen") public final class SolutionVersion extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SolutionVersion.Builder,SolutionVersion>
An object that provides information about a specific version of a Solution in a Custom dataset group.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSolutionVersion.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SolutionVersion.Builderbuilder()InstantcreationDateTime()The date and time (in Unix time) that this version of the solution was created.StringdatasetGroupArn()The Amazon Resource Name (ARN) of the dataset group providing the training data.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringeventType()The event type (for example, 'click' or 'like') that is used for training the model.StringfailureReason()If training a solution version fails, the reason for the failure.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()InstantlastUpdatedDateTime()The date and time (in Unix time) that the solution was last updated.Stringname()The name of the solution version.BooleanperformAutoML()When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration.BooleanperformHPO()Whether to perform hyperparameter optimization (HPO) on the chosen recipe.StringrecipeArn()The ARN of the recipe used in the solution.List<SdkField<?>>sdkFields()static Class<? extends SolutionVersion.Builder>serializableBuilderClass()StringsolutionArn()The ARN of the solution.SolutionConfigsolutionConfig()Describes the configuration properties for the solution.StringsolutionVersionArn()The ARN of the solution version.Stringstatus()The status of the solution version.SolutionVersion.BuildertoBuilder()StringtoString()Returns a string representation of this object.DoubletrainingHours()The time used to train the model.TrainingModetrainingMode()The scope of training to be performed when creating the solution version.StringtrainingModeAsString()The scope of training to be performed when creating the solution version.TrainingTypetrainingType()Whether the solution version was created automatically or manually.StringtrainingTypeAsString()Whether the solution version was created automatically or manually.TunedHPOParamstunedHPOParams()If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
name
public final String name()
The name of the solution version.
- Returns:
- The name of the solution version.
-
solutionVersionArn
public final String solutionVersionArn()
The ARN of the solution version.
- Returns:
- The ARN of the solution version.
-
solutionArn
public final String solutionArn()
The ARN of the solution.
- Returns:
- The ARN of the solution.
-
performHPO
public final Boolean performHPO()
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.
-
performAutoML
public final Boolean performAutoML()
When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses
recipeArn.- Returns:
- When true, Amazon Personalize searches for the most optimal recipe according to the solution
configuration. When false (the default), Amazon Personalize uses
recipeArn.
-
recipeArn
public final String recipeArn()
The ARN of the recipe used in the solution.
- Returns:
- The ARN of the recipe used in the solution.
-
eventType
public final String eventType()
The event type (for example, 'click' or 'like') that is used for training the model.
- Returns:
- The event type (for example, 'click' or 'like') that is used for training the model.
-
datasetGroupArn
public final String datasetGroupArn()
The Amazon Resource Name (ARN) of the dataset group providing the training data.
- Returns:
- The Amazon Resource Name (ARN) of the dataset group providing the training data.
-
solutionConfig
public final SolutionConfig solutionConfig()
Describes the configuration properties for the solution.
- Returns:
- Describes the configuration properties for the solution.
-
trainingHours
public final Double trainingHours()
The time used to train the model. You are billed for the time it takes to train a model. This field is visible only after Amazon Personalize successfully trains a model.
- Returns:
- The time used to train the model. You are billed for the time it takes to train a model. This field is visible only after Amazon Personalize successfully trains a model.
-
trainingMode
public final TrainingMode trainingMode()
The scope of training to be performed when creating the solution version. A
FULLtraining considers all of the data in your dataset group. AnUPDATEprocesses only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can useUPDATE.If the service returns an enum value that is not available in the current SDK version,
trainingModewill returnTrainingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtrainingModeAsString().- Returns:
- The scope of training to be performed when creating the solution version. A
FULLtraining considers all of the data in your dataset group. AnUPDATEprocesses only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can useUPDATE. - See Also:
TrainingMode
-
trainingModeAsString
public final String trainingModeAsString()
The scope of training to be performed when creating the solution version. A
FULLtraining considers all of the data in your dataset group. AnUPDATEprocesses only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can useUPDATE.If the service returns an enum value that is not available in the current SDK version,
trainingModewill returnTrainingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtrainingModeAsString().- Returns:
- The scope of training to be performed when creating the solution version. A
FULLtraining considers all of the data in your dataset group. AnUPDATEprocesses only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can useUPDATE. - See Also:
TrainingMode
-
tunedHPOParams
public final TunedHPOParams tunedHPOParams()
If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.
- Returns:
- If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.
-
status
public final String status()
The status of the solution version.
A solution version can be in one of the following states:
-
CREATE PENDING
-
CREATE IN_PROGRESS
-
ACTIVE
-
CREATE FAILED
-
CREATE STOPPING
-
CREATE STOPPED
- Returns:
- The status of the solution version.
A solution version can be in one of the following states:
-
CREATE PENDING
-
CREATE IN_PROGRESS
-
ACTIVE
-
CREATE FAILED
-
CREATE STOPPING
-
CREATE STOPPED
-
-
-
failureReason
public final String failureReason()
If training a solution version fails, the reason for the failure.
- Returns:
- If training a solution version fails, the reason for the failure.
-
creationDateTime
public final Instant creationDateTime()
The date and time (in Unix time) that this version of the solution was created.
- Returns:
- The date and time (in Unix time) that this version of the solution was created.
-
lastUpdatedDateTime
public final Instant lastUpdatedDateTime()
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.
-
trainingType
public final TrainingType trainingType()
Whether the solution version was created automatically or manually.
If the service returns an enum value that is not available in the current SDK version,
trainingTypewill returnTrainingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtrainingTypeAsString().- Returns:
- Whether the solution version was created automatically or manually.
- See Also:
TrainingType
-
trainingTypeAsString
public final String trainingTypeAsString()
Whether the solution version was created automatically or manually.
If the service returns an enum value that is not available in the current SDK version,
trainingTypewill returnTrainingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtrainingTypeAsString().- Returns:
- Whether the solution version was created automatically or manually.
- See Also:
TrainingType
-
toBuilder
public SolutionVersion.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<SolutionVersion.Builder,SolutionVersion>
-
builder
public static SolutionVersion.Builder builder()
-
serializableBuilderClass
public static Class<? extends SolutionVersion.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final 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.
-
-