Class RetrainingSchedulerSummary

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

Provides information about the specified retraining scheduler, including model name, status, start date, frequency, and lookback window.

See Also:

  • Method Details

    • modelName

      public final String modelName()

      The name of the model that the retraining scheduler is attached to.

      Returns:
      The name of the model that the retraining scheduler is attached to.

    • modelArn

      public final String modelArn()

      The ARN of the model that the retraining scheduler is attached to.

      Returns:
      The ARN of the model that the retraining scheduler is attached to.

    • status

      public final RetrainingSchedulerStatus status()

      The status of the retraining scheduler.

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

      Returns:
      The status of the retraining scheduler.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the retraining scheduler.

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

      Returns:
      The status of the retraining scheduler.
      See Also:

    • retrainingStartDate

      public final Instant retrainingStartDate()

      The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.

      Returns:
      The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.

    • retrainingFrequency

      public final String retrainingFrequency()

      The frequency at which the model retraining is set. This follows the ISO 8601 guidelines.

      Returns:
      The frequency at which the model retraining is set. This follows the ISO 8601 guidelines.

    • lookbackWindow

      public final String lookbackWindow()

      The number of past days of data used for retraining.

      Returns:
      The number of past days of data used for retraining.

    • toBuilder

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

    • builder

      public static RetrainingSchedulerSummary.Builder builder()

    • serializableBuilderClass

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