Class ModelDescription

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

Describes an Amazon Lookout for Vision model.

See Also:

  • Method Details

    • modelVersion

      public final String modelVersion()

      The version of the model

      Returns:
      The version of the model

    • modelArn

      public final String modelArn()

      The Amazon Resource Name (ARN) of the model.

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

    • creationTimestamp

      public final Instant creationTimestamp()

      The unix timestamp for the date and time that the model was created.

      Returns:
      The unix timestamp for the date and time that the model was created.

    • description

      public final String description()

      The description for the model.

      Returns:
      The description for the model.

    • status

      public final ModelStatus status()

      The status of the model.

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

      Returns:
      The status of the model.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the model.

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

      Returns:
      The status of the model.
      See Also:

    • statusMessage

      public final String statusMessage()

      The status message for the model.

      Returns:
      The status message for the model.

    • performance

      public final ModelPerformance performance()

      Performance metrics for the model. Created during training.

      Returns:
      Performance metrics for the model. Created during training.

    • outputConfig

      public final OutputConfig outputConfig()

      The S3 location where Amazon Lookout for Vision saves model training files.

      Returns:
      The S3 location where Amazon Lookout for Vision saves model training files.

    • evaluationManifest

      public final OutputS3Object evaluationManifest()

      The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.

      Returns:
      The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.

    • evaluationResult

      public final OutputS3Object evaluationResult()

      The S3 location where Amazon Lookout for Vision saves the performance metrics.

      Returns:
      The S3 location where Amazon Lookout for Vision saves the performance metrics.

    • evaluationEndTimestamp

      public final Instant evaluationEndTimestamp()

      The unix timestamp for the date and time that the evaluation ended.

      Returns:
      The unix timestamp for the date and time that the evaluation ended.

    • kmsKeyId

      public final String kmsKeyId()

      The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.

      Returns:
      The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.

    • minInferenceUnits

      public final Integer minInferenceUnits()

      The minimum number of inference units used by the model. For more information, see StartModel

      Returns:
      The minimum number of inference units used by the model. For more information, see StartModel

    • maxInferenceUnits

      public final Integer maxInferenceUnits()

      The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more information, see StartModel.

      Returns:
      The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more information, see StartModel.

    • toBuilder

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

    • builder

      public static ModelDescription.Builder builder()

    • serializableBuilderClass

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