Package software.amazon.awssdk.services.lookoutequipment.model

Class CreateRetrainingSchedulerRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.lookoutequipment.model.LookoutEquipmentRequest
software.amazon.awssdk.services.lookoutequipment.model.CreateRetrainingSchedulerRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateRetrainingSchedulerRequest.Builder,CreateRetrainingSchedulerRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateRetrainingSchedulerRequest extends LookoutEquipmentRequest implements ToCopyableBuilder<CreateRetrainingSchedulerRequest.Builder,CreateRetrainingSchedulerRequest>

  • Method Details

    • modelName

      public final String modelName()

      The name of the model to add the retraining scheduler to.

      Returns:
      The name of the model to add the retraining scheduler to.

    • 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()

      This parameter uses the ISO 8601 standard to set the frequency at which you want retraining to occur in terms of Years, Months, and/or Days (note: other parameters like Time are not currently supported). The minimum value is 30 days (P30D) and the maximum value is 1 year (P1Y). For example, the following values are valid:

      • P3M15D – Every 3 months and 15 days

      • P2M – Every 2 months

      • P150D – Every 150 days

      Returns:
      This parameter uses the ISO 8601 standard to set the frequency at which you want retraining to occur in terms of Years, Months, and/or Days (note: other parameters like Time are not currently supported). The minimum value is 30 days (P30D) and the maximum value is 1 year (P1Y). For example, the following values are valid:

      • P3M15D – Every 3 months and 15 days

      • P2M – Every 2 months

      • P150D – Every 150 days

    • lookbackWindow

      public final String lookbackWindow()

      The number of past days of data that will be used for retraining.

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

    • promoteMode

      public final ModelPromoteMode promoteMode()

      Indicates how the service will use new models. In MANAGED mode, new models will automatically be used for inference if they have better performance than the current model. In MANUAL mode, the new models will not be used until they are manually activated.

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

      Returns:
      Indicates how the service will use new models. In MANAGED mode, new models will automatically be used for inference if they have better performance than the current model. In MANUAL mode, the new models will not be used until they are manually activated.
      See Also:

    • promoteModeAsString

      public final String promoteModeAsString()

      Indicates how the service will use new models. In MANAGED mode, new models will automatically be used for inference if they have better performance than the current model. In MANUAL mode, the new models will not be used until they are manually activated.

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

      Returns:
      Indicates how the service will use new models. In MANAGED mode, new models will automatically be used for inference if they have better performance than the current model. In MANUAL mode, the new models will not be used until they are manually activated.
      See Also:

    • clientToken

      public final String clientToken()

      A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

      Returns:
      A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

    • toBuilder

      public CreateRetrainingSchedulerRequest.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<CreateRetrainingSchedulerRequest.Builder,CreateRetrainingSchedulerRequest>
      Specified by:
      toBuilder in class LookoutEquipmentRequest
      Returns:
      a builder for type T

    • builder

      public static CreateRetrainingSchedulerRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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