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

Class ModelVersionSummary

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

Contains information about the specific model version.

See Also:

  • Method Details

    • modelName

      public final String modelName()

      The name of the model that this model version is a version of.

      Returns:
      The name of the model that this model version is a version of.

    • modelArn

      public final String modelArn()

      The Amazon Resource Name (ARN) of the model that this model version is a version of.

      Returns:
      The Amazon Resource Name (ARN) of the model that this model version is a version of.

    • modelVersion

      public final Long modelVersion()

      The version of the model.

      Returns:
      The version of the model.

    • modelVersionArn

      public final String modelVersionArn()

      The Amazon Resource Name (ARN) of the model version.

      Returns:
      The Amazon Resource Name (ARN) of the model version.

    • createdAt

      public final Instant createdAt()

      The time when this model version was created.

      Returns:
      The time when this model version was created.

    • status

      public final ModelVersionStatus status()

      The current status of the model version.

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

      Returns:
      The current status of the model version.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the model version.

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

      Returns:
      The current status of the model version.
      See Also:

    • sourceType

      public final ModelVersionSourceType sourceType()

      Indicates how this model version was generated.

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

      Returns:
      Indicates how this model version was generated.
      See Also:

    • sourceTypeAsString

      public final String sourceTypeAsString()

      Indicates how this model version was generated.

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

      Returns:
      Indicates how this model version was generated.
      See Also:

    • modelQuality

      public final ModelQuality modelQuality()

      Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED. Otherwise, the value is QUALITY_THRESHOLD_MET.

      If the model is unlabeled, the model quality can't be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.

      For information about improving the quality of a model, see Best practices with Amazon Lookout for Equipment.

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

      Returns:
      Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED. Otherwise, the value is QUALITY_THRESHOLD_MET.

      If the model is unlabeled, the model quality can't be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.

      For information about improving the quality of a model, see Best practices with Amazon Lookout for Equipment.

      See Also:

    • modelQualityAsString

      public final String modelQualityAsString()

      Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED. Otherwise, the value is QUALITY_THRESHOLD_MET.

      If the model is unlabeled, the model quality can't be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.

      For information about improving the quality of a model, see Best practices with Amazon Lookout for Equipment.

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

      Returns:
      Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED. Otherwise, the value is QUALITY_THRESHOLD_MET.

      If the model is unlabeled, the model quality can't be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.

      For information about improving the quality of a model, see Best practices with Amazon Lookout for Equipment.

      See Also:

    • toBuilder

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

    • builder

      public static ModelVersionSummary.Builder builder()

    • serializableBuilderClass

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