Class FlywheelIterationProperties

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

The configuration properties of a flywheel iteration.

See Also:

  • Method Details

    • flywheelArn

      public final String flywheelArn()

      Returns:

    • flywheelIterationId

      public final String flywheelIterationId()

      Returns:

    • creationTime

      public final Instant creationTime()

      The creation start time of the flywheel iteration.

      Returns:
      The creation start time of the flywheel iteration.

    • endTime

      public final Instant endTime()

      The completion time of this flywheel iteration.

      Returns:
      The completion time of this flywheel iteration.

    • status

      public final FlywheelIterationStatus status()

      The status of the flywheel iteration.

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

      Returns:
      The status of the flywheel iteration.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the flywheel iteration.

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

      Returns:
      The status of the flywheel iteration.
      See Also:

    • message

      public final String message()

      A description of the status of the flywheel iteration.

      Returns:
      A description of the status of the flywheel iteration.

    • evaluatedModelArn

      public final String evaluatedModelArn()

      The ARN of the evaluated model associated with this flywheel iteration.

      Returns:
      The ARN of the evaluated model associated with this flywheel iteration.

    • evaluatedModelMetrics

      public final FlywheelModelEvaluationMetrics evaluatedModelMetrics()
      Returns the value of the EvaluatedModelMetrics property for this object.
      Returns:
      The value of the EvaluatedModelMetrics property for this object.

    • trainedModelArn

      public final String trainedModelArn()

      The ARN of the trained model associated with this flywheel iteration.

      Returns:
      The ARN of the trained model associated with this flywheel iteration.

    • trainedModelMetrics

      public final FlywheelModelEvaluationMetrics trainedModelMetrics()

      The metrics associated with the trained model.

      Returns:
      The metrics associated with the trained model.

    • evaluationManifestS3Prefix

      public final String evaluationManifestS3Prefix()

      Returns:

    • toBuilder

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

    • builder

      public static FlywheelIterationProperties.Builder builder()

    • serializableBuilderClass

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