Class SolutionUpdateSummary

java.lang.Object
software.amazon.awssdk.services.personalize.model.SolutionUpdateSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SolutionUpdateSummary.Builder,SolutionUpdateSummary>
@Generated("software.amazon.awssdk:codegen") public final class SolutionUpdateSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SolutionUpdateSummary.Builder,SolutionUpdateSummary>

Provides a summary of the properties of a solution update. For a complete listing, call the DescribeSolution API.

See Also:

  • Method Details

    • solutionUpdateConfig

      public final SolutionUpdateConfig solutionUpdateConfig()

      The configuration details of the solution.

      Returns:
      The configuration details of the solution.

    • status

      public final String status()

      The status of the solution update. A solution update can be in one of the following states:

      CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

      Returns:
      The status of the solution update. A solution update can be in one of the following states:

      CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    • performAutoTraining

      public final Boolean performAutoTraining()

      Whether the solution automatically creates solution versions.

      Returns:
      Whether the solution automatically creates solution versions.

    • performIncrementalUpdate

      public final Boolean performIncrementalUpdate()

      A Boolean value that indicates whether incremental training updates are performed on the model. When enabled, this allows the model to learn from new data more frequently without requiring full retraining, which enables near real-time personalization. This parameter is supported only for solutions that use the semantic-similarity recipe.

      Returns:
      A Boolean value that indicates whether incremental training updates are performed on the model. When enabled, this allows the model to learn from new data more frequently without requiring full retraining, which enables near real-time personalization. This parameter is supported only for solutions that use the semantic-similarity recipe.

    • creationDateTime

      public final Instant creationDateTime()

      The date and time (in Unix format) that the solution update was created.

      Returns:
      The date and time (in Unix format) that the solution update was created.

    • lastUpdatedDateTime

      public final Instant lastUpdatedDateTime()

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

      Returns:
      The date and time (in Unix time) that the solution update was last updated.

    • failureReason

      public final String failureReason()

      If a solution update fails, the reason behind the failure.

      Returns:
      If a solution update fails, the reason behind the failure.

    • toBuilder

      public SolutionUpdateSummary.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<SolutionUpdateSummary.Builder,SolutionUpdateSummary>
      Returns:
      a builder for type T

    • builder

      public static SolutionUpdateSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SolutionUpdateSummary.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.