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

Interface DescribeModelResponse.Builder

    • Method Detail

      • modelName

        DescribeModelResponse.Builder modelName​(String modelName)

        The name of the machine learning model being described.

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

      • modelArn

        DescribeModelResponse.Builder modelArn​(String modelArn)

        The Amazon Resource Name (ARN) of the machine learning model being described.

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

      • datasetName

        DescribeModelResponse.Builder datasetName​(String datasetName)

        The name of the dataset being used by the machine learning being described.

        Parameters:
        datasetName - The name of the dataset being used by the machine learning being described.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • datasetArn

        DescribeModelResponse.Builder datasetArn​(String datasetArn)

        The Amazon Resouce Name (ARN) of the dataset used to create the machine learning model being described.

        Parameters:
        datasetArn - The Amazon Resouce Name (ARN) of the dataset used to create the machine learning model being described.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • schema

        DescribeModelResponse.Builder schema​(String schema)

        A JSON description of the data that is in each time series dataset, including names, column names, and data types.

        Parameters:
        schema - A JSON description of the data that is in each time series dataset, including names, column names, and data types.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • labelsInputConfiguration

        DescribeModelResponse.Builder labelsInputConfiguration​(LabelsInputConfiguration labelsInputConfiguration)

        Specifies configuration information about the labels input, including its S3 location.

        Parameters:
        labelsInputConfiguration - Specifies configuration information about the labels input, including its S3 location.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • trainingDataStartTime

        DescribeModelResponse.Builder trainingDataStartTime​(Instant trainingDataStartTime)

        Indicates the time reference in the dataset that was used to begin the subset of training data for the machine learning model.

        Parameters:
        trainingDataStartTime - Indicates the time reference in the dataset that was used to begin the subset of training data for the machine learning model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • trainingDataEndTime

        DescribeModelResponse.Builder trainingDataEndTime​(Instant trainingDataEndTime)

        Indicates the time reference in the dataset that was used to end the subset of training data for the machine learning model.

        Parameters:
        trainingDataEndTime - Indicates the time reference in the dataset that was used to end the subset of training data for the machine learning model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • evaluationDataStartTime

        DescribeModelResponse.Builder evaluationDataStartTime​(Instant evaluationDataStartTime)

        Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the machine learning model.

        Parameters:
        evaluationDataStartTime - Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the machine learning model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • evaluationDataEndTime

        DescribeModelResponse.Builder evaluationDataEndTime​(Instant evaluationDataEndTime)

        Indicates the time reference in the dataset that was used to end the subset of evaluation data for the machine learning model.

        Parameters:
        evaluationDataEndTime - Indicates the time reference in the dataset that was used to end the subset of evaluation data for the machine learning model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • roleArn

        DescribeModelResponse.Builder roleArn​(String roleArn)

        The Amazon Resource Name (ARN) of a role with permission to access the data source for the machine learning model being described.

        Parameters:
        roleArn - The Amazon Resource Name (ARN) of a role with permission to access the data source for the machine learning model being described.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataPreProcessingConfiguration

        DescribeModelResponse.Builder dataPreProcessingConfiguration​(DataPreProcessingConfiguration dataPreProcessingConfiguration)

        The configuration is the TargetSamplingRate, which is the sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

        When providing a value for the TargetSamplingRate, you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H

        Parameters:
        dataPreProcessingConfiguration - The configuration is the TargetSamplingRate, which is the sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

        When providing a value for the TargetSamplingRate, you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H

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

      • status

        DescribeModelResponse.Builder status​(String status)

        Specifies the current status of the model being described. Status describes the status of the most recent action of the model.

        Parameters:
        status - Specifies the current status of the model being described. Status describes the status of the most recent action of the model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ModelStatus, ModelStatus

      • status

        DescribeModelResponse.Builder status​(ModelStatus status)

        Specifies the current status of the model being described. Status describes the status of the most recent action of the model.

        Parameters:
        status - Specifies the current status of the model being described. Status describes the status of the most recent action of the model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ModelStatus, ModelStatus

      • trainingExecutionStartTime

        DescribeModelResponse.Builder trainingExecutionStartTime​(Instant trainingExecutionStartTime)

        Indicates the time at which the training of the machine learning model began.

        Parameters:
        trainingExecutionStartTime - Indicates the time at which the training of the machine learning model began.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • trainingExecutionEndTime

        DescribeModelResponse.Builder trainingExecutionEndTime​(Instant trainingExecutionEndTime)

        Indicates the time at which the training of the machine learning model was completed.

        Parameters:
        trainingExecutionEndTime - Indicates the time at which the training of the machine learning model was completed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • failedReason

        DescribeModelResponse.Builder failedReason​(String failedReason)

        If the training of the machine learning model failed, this indicates the reason for that failure.

        Parameters:
        failedReason - If the training of the machine learning model failed, this indicates the reason for that failure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modelMetrics

        DescribeModelResponse.Builder modelMetrics​(String modelMetrics)

        The Model Metrics show an aggregated summary of the model's performance within the evaluation time range. This is the JSON content of the metrics created when evaluating the model.

        Parameters:
        modelMetrics - The Model Metrics show an aggregated summary of the model's performance within the evaluation time range. This is the JSON content of the metrics created when evaluating the model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastUpdatedTime

        DescribeModelResponse.Builder lastUpdatedTime​(Instant lastUpdatedTime)

        Indicates the last time the machine learning model was updated. The type of update is not specified.

        Parameters:
        lastUpdatedTime - Indicates the last time the machine learning model was updated. The type of update is not specified.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createdAt

        DescribeModelResponse.Builder createdAt​(Instant createdAt)

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

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

      • serverSideKmsKeyId

        DescribeModelResponse.Builder serverSideKmsKeyId​(String serverSideKmsKeyId)

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

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

      • offCondition

        DescribeModelResponse.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

        DescribeModelResponse.Builder sourceModelVersionArn​(String sourceModelVersionArn)

        The Amazon Resource Name (ARN) of the source model version. This field appears if the active model version was imported.

        Parameters:
        sourceModelVersionArn - The Amazon Resource Name (ARN) of the source model version. This field appears if the active model version was imported.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • importJobStartTime

        DescribeModelResponse.Builder importJobStartTime​(Instant importJobStartTime)

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

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

      • importJobEndTime

        DescribeModelResponse.Builder importJobEndTime​(Instant importJobEndTime)

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

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

      • activeModelVersion

        DescribeModelResponse.Builder activeModelVersion​(Long activeModelVersion)

        The name of the model version used by the inference schedular when running a scheduled inference execution.

        Parameters:
        activeModelVersion - The name of the model version used by the inference schedular when running a scheduled inference execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • activeModelVersionArn

        DescribeModelResponse.Builder activeModelVersionArn​(String activeModelVersionArn)

        The Amazon Resource Name (ARN) of the model version used by the inference scheduler when running a scheduled inference execution.

        Parameters:
        activeModelVersionArn - The Amazon Resource Name (ARN) of the model version used by the inference scheduler when running a scheduled inference execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modelVersionActivatedAt

        DescribeModelResponse.Builder modelVersionActivatedAt​(Instant modelVersionActivatedAt)

        The date the active model version was activated.

        Parameters:
        modelVersionActivatedAt - The date the active model version was activated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • previousActiveModelVersion

        DescribeModelResponse.Builder previousActiveModelVersion​(Long previousActiveModelVersion)

        The model version that was set as the active model version prior to the current active model version.

        Parameters:
        previousActiveModelVersion - The model version that was set as the active model version prior to the current active model version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • previousActiveModelVersionArn

        DescribeModelResponse.Builder previousActiveModelVersionArn​(String previousActiveModelVersionArn)

        The ARN of the model version that was set as the active model version prior to the current active model version.

        Parameters:
        previousActiveModelVersionArn - The ARN of the model version that was set as the active model version prior to the current active model version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • previousModelVersionActivatedAt

        DescribeModelResponse.Builder previousModelVersionActivatedAt​(Instant previousModelVersionActivatedAt)

        The date and time when the previous active model version was activated.

        Parameters:
        previousModelVersionActivatedAt - The date and time when the previous active model version was activated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • priorModelMetrics

        DescribeModelResponse.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.

      • latestScheduledRetrainingFailedReason

        DescribeModelResponse.Builder latestScheduledRetrainingFailedReason​(String latestScheduledRetrainingFailedReason)

        If the model version was generated by retraining and the training failed, this indicates the reason for that failure.

        Parameters:
        latestScheduledRetrainingFailedReason - If the model version was generated by retraining and the training failed, this indicates the reason for that failure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • latestScheduledRetrainingStatus

        DescribeModelResponse.Builder latestScheduledRetrainingStatus​(String latestScheduledRetrainingStatus)

        Indicates the status of the most recent scheduled retraining run.

        Parameters:
        latestScheduledRetrainingStatus - Indicates the status of the most recent scheduled retraining run.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ModelVersionStatus, ModelVersionStatus

      • latestScheduledRetrainingStatus

        DescribeModelResponse.Builder latestScheduledRetrainingStatus​(ModelVersionStatus latestScheduledRetrainingStatus)

        Indicates the status of the most recent scheduled retraining run.

        Parameters:
        latestScheduledRetrainingStatus - Indicates the status of the most recent scheduled retraining run.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ModelVersionStatus, ModelVersionStatus

      • latestScheduledRetrainingModelVersion

        DescribeModelResponse.Builder latestScheduledRetrainingModelVersion​(Long latestScheduledRetrainingModelVersion)

        Indicates the most recent model version that was generated by retraining.

        Parameters:
        latestScheduledRetrainingModelVersion - Indicates the most recent model version that was generated by retraining.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • latestScheduledRetrainingStartTime

        DescribeModelResponse.Builder latestScheduledRetrainingStartTime​(Instant latestScheduledRetrainingStartTime)

        Indicates the start time of the most recent scheduled retraining run.

        Parameters:
        latestScheduledRetrainingStartTime - Indicates the start time of the most recent scheduled retraining run.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • latestScheduledRetrainingAvailableDataInDays

        DescribeModelResponse.Builder latestScheduledRetrainingAvailableDataInDays​(Integer latestScheduledRetrainingAvailableDataInDays)

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

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

      • nextScheduledRetrainingStartDate

        DescribeModelResponse.Builder nextScheduledRetrainingStartDate​(Instant nextScheduledRetrainingStartDate)

        Indicates the date and time that the next scheduled retraining run will start on. Lookout for Equipment truncates the time you provide to the nearest UTC day.

        Parameters:
        nextScheduledRetrainingStartDate - Indicates the date and time that the next scheduled retraining run will start on. Lookout for Equipment truncates the time you provide to the nearest UTC day.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • accumulatedInferenceDataStartTime

        DescribeModelResponse.Builder accumulatedInferenceDataStartTime​(Instant accumulatedInferenceDataStartTime)

        Indicates the start time of the inference data that has been accumulated.

        Parameters:
        accumulatedInferenceDataStartTime - Indicates the start time of the inference data that has been accumulated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • accumulatedInferenceDataEndTime

        DescribeModelResponse.Builder accumulatedInferenceDataEndTime​(Instant accumulatedInferenceDataEndTime)

        Indicates the end time of the inference data that has been accumulated.

        Parameters:
        accumulatedInferenceDataEndTime - Indicates the end time of the inference data that has been accumulated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modelDiagnosticsOutputConfiguration

        DescribeModelResponse.Builder modelDiagnosticsOutputConfiguration​(ModelDiagnosticsOutputConfiguration modelDiagnosticsOutputConfiguration)

        Configuration information for the model's pointwise model diagnostics.

        Parameters:
        modelDiagnosticsOutputConfiguration - Configuration information for the model's pointwise model diagnostics.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modelQuality

        DescribeModelResponse.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

        DescribeModelResponse.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