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

Class DescribeModelVersionResponse

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

  • Method Details

    • modelName

      public final String modelName()

      The name of the machine learning model that this version belongs to.

      Returns:
      The name of the machine learning model that this version belongs to.

    • modelArn

      public final String modelArn()

      The Amazon Resource Name (ARN) of the parent machine learning model that this version belong to.

      Returns:
      The Amazon Resource Name (ARN) of the parent machine learning model that this version belong to.

    • modelVersion

      public final Long modelVersion()

      The version of the machine learning model.

      Returns:
      The version of the machine learning 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.

    • 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 whether this model version was created by training or by importing.

      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 whether this model version was created by training or by importing.
      See Also:

    • sourceTypeAsString

      public final String sourceTypeAsString()

      Indicates whether this model version was created by training or by importing.

      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 whether this model version was created by training or by importing.
      See Also:

    • datasetName

      public final String datasetName()

      The name of the dataset used to train the model version.

      Returns:
      The name of the dataset used to train the model version.

    • datasetArn

      public final String datasetArn()

      The Amazon Resource Name (ARN) of the dataset used to train the model version.

      Returns:
      The Amazon Resource Name (ARN) of the dataset used to train the model version.

    • schema

      public final String schema()

      The schema of the data used to train the model version.

      Returns:
      The schema of the data used to train the model version.

    • labelsInputConfiguration

      public final LabelsInputConfiguration labelsInputConfiguration()
      Returns the value of the LabelsInputConfiguration property for this object.
      Returns:
      The value of the LabelsInputConfiguration property for this object.

    • trainingDataStartTime

      public final Instant trainingDataStartTime()

      The date on which the training data began being gathered. If you imported the version, this is the date that the training data in the source version began being gathered.

      Returns:
      The date on which the training data began being gathered. If you imported the version, this is the date that the training data in the source version began being gathered.

    • trainingDataEndTime

      public final Instant trainingDataEndTime()

      The date on which the training data finished being gathered. If you imported the version, this is the date that the training data in the source version finished being gathered.

      Returns:
      The date on which the training data finished being gathered. If you imported the version, this is the date that the training data in the source version finished being gathered.

    • evaluationDataStartTime

      public final Instant evaluationDataStartTime()

      The date on which the data in the evaluation set began being gathered. If you imported the version, this is the date that the evaluation set data in the source version began being gathered.

      Returns:
      The date on which the data in the evaluation set began being gathered. If you imported the version, this is the date that the evaluation set data in the source version began being gathered.

    • evaluationDataEndTime

      public final Instant evaluationDataEndTime()

      The date on which the data in the evaluation set began being gathered. If you imported the version, this is the date that the evaluation set data in the source version finished being gathered.

      Returns:
      The date on which the data in the evaluation set began being gathered. If you imported the version, this is the date that the evaluation set data in the source version finished being gathered.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the role that was used to train the model version.

      Returns:
      The Amazon Resource Name (ARN) of the role that was used to train the model version.

    • dataPreProcessingConfiguration

      public final DataPreProcessingConfiguration dataPreProcessingConfiguration()
      Returns the value of the DataPreProcessingConfiguration property for this object.
      Returns:
      The value of the DataPreProcessingConfiguration property for this object.

    • trainingExecutionStartTime

      public final Instant trainingExecutionStartTime()

      The time when the training of the version began.

      Returns:
      The time when the training of the version began.

    • trainingExecutionEndTime

      public final Instant trainingExecutionEndTime()

      The time when the training of the version completed.

      Returns:
      The time when the training of the version completed.

    • failedReason

      public final String failedReason()

      The failure message if the training of the model version failed.

      Returns:
      The failure message if the training of the model version failed.

    • modelMetrics

      public final String modelMetrics()

      Shows an aggregated summary, in JSON format, of the model's performance within the evaluation time range. These metrics are created when evaluating the model.

      Returns:
      Shows an aggregated summary, in JSON format, of the model's performance within the evaluation time range. These metrics are created when evaluating the model.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      Indicates the last time the machine learning model version was updated.

      Returns:
      Indicates the last time the machine learning model version was updated.

    • createdAt

      public final Instant createdAt()

      Indicates the time and date at which the machine learning model version was created.

      Returns:
      Indicates the time and date at which the machine learning model version was created.

    • serverSideKmsKeyId

      public final String serverSideKmsKeyId()

      The identifier of the KMS key key used to encrypt model version data by Amazon Lookout for Equipment.

      Returns:
      The identifier of the KMS key key used to encrypt model version data by Amazon Lookout for Equipment.

    • offCondition

      public final String offCondition()

      Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.

      Returns:
      Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.

    • sourceModelVersionArn

      public final String sourceModelVersionArn()

      If model version was imported, then this field is the arn of the source model version.

      Returns:
      If model version was imported, then this field is the arn of the source model version.

    • importJobStartTime

      public final Instant importJobStartTime()

      The date and time when the import job began. This field appears if the model version was imported.

      Returns:
      The date and time when the import job began. This field appears if the model version was imported.

    • importJobEndTime

      public final Instant importJobEndTime()

      The date and time when the import job completed. This field appears if the model version was imported.

      Returns:
      The date and time when the import job completed. This field appears if the model version was imported.

    • importedDataSizeInBytes

      public final Long importedDataSizeInBytes()

      The size in bytes of the imported data. This field appears if the model version was imported.

      Returns:
      The size in bytes of the imported data. This field appears if the model version was imported.

    • priorModelMetrics

      public final String priorModelMetrics()

      If the model version was retrained, this field shows a summary of the performance of the prior model on the new training range. You can use the information in this JSON-formatted object to compare the new model version and the prior model version.

      Returns:
      If the model version was retrained, this field shows a summary of the performance of the prior model on the new training range. You can use the information in this JSON-formatted object to compare the new model version and the prior model version.

    • retrainingAvailableDataInDays

      public final Integer retrainingAvailableDataInDays()

      Indicates the number of days of data used in the most recent scheduled retraining run.

      Returns:
      Indicates the number of days of data used in the most recent scheduled retraining run.

    • autoPromotionResult

      public final AutoPromotionResult autoPromotionResult()

      Indicates whether the model version was promoted to be the active version after retraining or if there was an error with or cancellation of the retraining.

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

      Returns:
      Indicates whether the model version was promoted to be the active version after retraining or if there was an error with or cancellation of the retraining.
      See Also:

    • autoPromotionResultAsString

      public final String autoPromotionResultAsString()

      Indicates whether the model version was promoted to be the active version after retraining or if there was an error with or cancellation of the retraining.

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

      Returns:
      Indicates whether the model version was promoted to be the active version after retraining or if there was an error with or cancellation of the retraining.
      See Also:

    • autoPromotionResultReason

      public final String autoPromotionResultReason()

      Indicates the reason for the AutoPromotionResult. For example, a model might not be promoted if its performance was worse than the active version, if there was an error during training, or if the retraining scheduler was using MANUAL promote mode. The model will be promoted in MANAGED promote mode if the performance is better than the previous model.

      Returns:
      Indicates the reason for the AutoPromotionResult. For example, a model might not be promoted if its performance was worse than the active version, if there was an error during training, or if the retraining scheduler was using MANUAL promote mode. The model will be promoted in MANAGED promote mode if the performance is better than the previous model.

    • modelDiagnosticsOutputConfiguration

      public final ModelDiagnosticsOutputConfiguration modelDiagnosticsOutputConfiguration()

      The Amazon S3 location where Amazon Lookout for Equipment saves the pointwise model diagnostics for the model version.

      Returns:
      The Amazon S3 location where Amazon Lookout for Equipment saves the pointwise model diagnostics for the model version.

    • modelDiagnosticsResultsObject

      public final S3Object modelDiagnosticsResultsObject()

      The Amazon S3 output prefix for where Lookout for Equipment saves the pointwise model diagnostics for the model version.

      Returns:
      The Amazon S3 output prefix for where Lookout for Equipment saves the pointwise model diagnostics for the model version.

    • 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 using labels with your models, see Understanding labeling.

      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 using labels with your models, see Understanding labeling.

      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 using labels with your models, see Understanding labeling.

      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 using labels with your models, see Understanding labeling.

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

      See Also:

    • toBuilder

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

    • builder

      public static DescribeModelVersionResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.