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

Interface DescribeModelVersionResponse.Builder

    • Method Detail

      • modelName

        DescribeModelVersionResponse.Builder modelName​(String modelName)

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

        Parameters:
        modelName - The name of the machine learning model that this version belongs to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modelArn

        DescribeModelVersionResponse.Builder modelArn​(String modelArn)

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

        Parameters:
        modelArn - The Amazon Resource Name (ARN) of the parent machine learning model that this version belong to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modelVersion

        DescribeModelVersionResponse.Builder modelVersion​(Long modelVersion)

        The version of the machine learning model.

        Parameters:
        modelVersion - The version of the machine learning model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modelVersionArn

        DescribeModelVersionResponse.Builder modelVersionArn​(String modelVersionArn)

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

        Parameters:
        modelVersionArn - The Amazon Resource Name (ARN) of the model version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • datasetName

        DescribeModelVersionResponse.Builder datasetName​(String datasetName)

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

        Parameters:
        datasetName - The name of the dataset used to train the model version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • datasetArn

        DescribeModelVersionResponse.Builder datasetArn​(String datasetArn)

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

        Parameters:
        datasetArn - The Amazon Resource Name (ARN) of the dataset used to train the model version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • schema

        DescribeModelVersionResponse.Builder schema​(String schema)

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

        Parameters:
        schema - The schema of the data used to train the model version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • labelsInputConfiguration

        DescribeModelVersionResponse.Builder labelsInputConfiguration​(LabelsInputConfiguration labelsInputConfiguration)
        Sets the value of the LabelsInputConfiguration property for this object.
        Parameters:
        labelsInputConfiguration - The new value for the LabelsInputConfiguration property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • trainingDataStartTime

        DescribeModelVersionResponse.Builder trainingDataStartTime​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • trainingDataEndTime

        DescribeModelVersionResponse.Builder trainingDataEndTime​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • evaluationDataStartTime

        DescribeModelVersionResponse.Builder evaluationDataStartTime​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • evaluationDataEndTime

        DescribeModelVersionResponse.Builder evaluationDataEndTime​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • roleArn

        DescribeModelVersionResponse.Builder roleArn​(String roleArn)

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

        Parameters:
        roleArn - The Amazon Resource Name (ARN) of the role that was used to train the model version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataPreProcessingConfiguration

        DescribeModelVersionResponse.Builder dataPreProcessingConfiguration​(DataPreProcessingConfiguration dataPreProcessingConfiguration)
        Sets the value of the DataPreProcessingConfiguration property for this object.
        Parameters:
        dataPreProcessingConfiguration - The new value for the DataPreProcessingConfiguration property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • trainingExecutionStartTime

        DescribeModelVersionResponse.Builder trainingExecutionStartTime​(Instant trainingExecutionStartTime)

        The time when the training of the version began.

        Parameters:
        trainingExecutionStartTime - The time when the training of the version began.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • trainingExecutionEndTime

        DescribeModelVersionResponse.Builder trainingExecutionEndTime​(Instant trainingExecutionEndTime)

        The time when the training of the version completed.

        Parameters:
        trainingExecutionEndTime - The time when the training of the version completed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • failedReason

        DescribeModelVersionResponse.Builder failedReason​(String failedReason)

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

        Parameters:
        failedReason - The failure message if the training of the model version failed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modelMetrics

        DescribeModelVersionResponse.Builder modelMetrics​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • lastUpdatedTime

        DescribeModelVersionResponse.Builder lastUpdatedTime​(Instant lastUpdatedTime)

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

        Parameters:
        lastUpdatedTime - Indicates the last time the machine learning model version was updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createdAt

        DescribeModelVersionResponse.Builder createdAt​(Instant createdAt)

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

        Parameters:
        createdAt - Indicates the time and date at which the machine learning model version was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serverSideKmsKeyId

        DescribeModelVersionResponse.Builder serverSideKmsKeyId​(String serverSideKmsKeyId)

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

        Parameters:
        serverSideKmsKeyId - The identifier of the KMS key key used to encrypt model version data by Amazon Lookout for Equipment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • offCondition

        DescribeModelVersionResponse.Builder offCondition​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • sourceModelVersionArn

        DescribeModelVersionResponse.Builder sourceModelVersionArn​(String sourceModelVersionArn)

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

        Parameters:
        sourceModelVersionArn - If model version was imported, then this field is the arn of the source model version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • importJobStartTime

        DescribeModelVersionResponse.Builder importJobStartTime​(Instant importJobStartTime)

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

        Parameters:
        importJobStartTime - The date and time when the import job began. This field appears if the model version was imported.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • importJobEndTime

        DescribeModelVersionResponse.Builder importJobEndTime​(Instant importJobEndTime)

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

        Parameters:
        importJobEndTime - The date and time when the import job completed. This field appears if the model version was imported.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • importedDataSizeInBytes

        DescribeModelVersionResponse.Builder importedDataSizeInBytes​(Long importedDataSizeInBytes)

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

        Parameters:
        importedDataSizeInBytes - The size in bytes of the imported data. This field appears if the model version was imported.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • priorModelMetrics

        DescribeModelVersionResponse.Builder priorModelMetrics​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • retrainingAvailableDataInDays

        DescribeModelVersionResponse.Builder retrainingAvailableDataInDays​(Integer retrainingAvailableDataInDays)

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

        Parameters:
        retrainingAvailableDataInDays - Indicates the number of days of data used in the most recent scheduled retraining run.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoPromotionResult

        DescribeModelVersionResponse.Builder autoPromotionResult​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AutoPromotionResult, AutoPromotionResult

      • autoPromotionResult

        DescribeModelVersionResponse.Builder autoPromotionResult​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AutoPromotionResult, AutoPromotionResult

      • autoPromotionResultReason

        DescribeModelVersionResponse.Builder autoPromotionResultReason​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • modelDiagnosticsOutputConfiguration

        DescribeModelVersionResponse.Builder modelDiagnosticsOutputConfiguration​(ModelDiagnosticsOutputConfiguration modelDiagnosticsOutputConfiguration)

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

        Parameters:
        modelDiagnosticsOutputConfiguration - The Amazon S3 location where Amazon Lookout for Equipment saves the pointwise model diagnostics for the model version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modelDiagnosticsResultsObject

        DescribeModelVersionResponse.Builder modelDiagnosticsResultsObject​(S3Object modelDiagnosticsResultsObject)

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

        Parameters:
        modelDiagnosticsResultsObject - The Amazon S3 output prefix for where Lookout for Equipment saves the pointwise model diagnostics for the model version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modelQuality

        DescribeModelVersionResponse.Builder modelQuality​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ModelQuality, ModelQuality

      • modelQuality

        DescribeModelVersionResponse.Builder modelQuality​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ModelQuality, ModelQuality