Package software.amazon.awssdk.services.personalize.model

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:

  • Method Details

    • 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. The FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the data that has changed in comparison to the input solution. Choose UPDATE when you want to incrementally update your solution version instead of creating an entirely new one.

      The UPDATE option can only be used when you already have an active solution version created from the input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe.

      If the service returns an enum value that is not available in the current SDK version, trainingMode will return TrainingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from trainingModeAsString().

      Returns:
      The scope of training to be performed when creating the solution version. The FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the data that has changed in comparison to the input solution. Choose UPDATE when you want to incrementally update your solution version instead of creating an entirely new one.

      The UPDATE option can only be used when you already have an active solution version created from the input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe.

      See Also:

    • trainingModeAsString

      public final String trainingModeAsString()

      The scope of training to be performed when creating the solution version. The FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the data that has changed in comparison to the input solution. Choose UPDATE when you want to incrementally update your solution version instead of creating an entirely new one.

      The UPDATE option can only be used when you already have an active solution version created from the input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe.

      If the service returns an enum value that is not available in the current SDK version, trainingMode will return TrainingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from trainingModeAsString().

      Returns:
      The scope of training to be performed when creating the solution version. The FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the data that has changed in comparison to the input solution. Choose UPDATE when you want to incrementally update your solution version instead of creating an entirely new one.

      The UPDATE option can only be used when you already have an active solution version created from the input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe.

      See Also:

    • 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.

    • toBuilder

      public SolutionVersion.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SolutionVersion.Builder,SolutionVersion>
      Returns:
      a builder for type T

    • builder

      public static SolutionVersion.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SolutionVersion.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.