DescribeModelVersionResponse.Builder (AWS Java SDK :: Services

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeModelVersionResponse.Builder,DescribeModelVersionResponse>, LookoutEquipmentResponse.Builder, SdkBuilder<DescribeModelVersionResponse.Builder,DescribeModelVersionResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeModelVersionResponse
```
public static interface DescribeModelVersionResponse.Builder
extends LookoutEquipmentResponse.Builder, SdkPojo, CopyableBuilder<DescribeModelVersionResponse.Builder,DescribeModelVersionResponse>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`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.
`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.
`DescribeModelVersionResponse.Builder`	`autoPromotionResultReason(String autoPromotionResultReason)` Indicates the reason for the `AutoPromotionResult`.
`DescribeModelVersionResponse.Builder`	`createdAt(Instant createdAt)` Indicates the time and date at which the machine learning model version was created.
`default DescribeModelVersionResponse.Builder`	`dataPreProcessingConfiguration(Consumer<DataPreProcessingConfiguration.Builder> dataPreProcessingConfiguration)` Sets the value of the DataPreProcessingConfiguration property for this object.
`DescribeModelVersionResponse.Builder`	`dataPreProcessingConfiguration(DataPreProcessingConfiguration dataPreProcessingConfiguration)` Sets the value of the DataPreProcessingConfiguration property for this object.
`DescribeModelVersionResponse.Builder`	`datasetArn(String datasetArn)` The Amazon Resource Name (ARN) of the dataset used to train the model version.
`DescribeModelVersionResponse.Builder`	`datasetName(String datasetName)` The name of the dataset used to train the model version.
`DescribeModelVersionResponse.Builder`	`evaluationDataEndTime(Instant evaluationDataEndTime)` The date on which the data in the evaluation set began being gathered.
`DescribeModelVersionResponse.Builder`	`evaluationDataStartTime(Instant evaluationDataStartTime)` The date on which the data in the evaluation set began being gathered.
`DescribeModelVersionResponse.Builder`	`failedReason(String failedReason)` The failure message if the training of the model version failed.
`DescribeModelVersionResponse.Builder`	`importedDataSizeInBytes(Long importedDataSizeInBytes)` The size in bytes of the imported data.
`DescribeModelVersionResponse.Builder`	`importJobEndTime(Instant importJobEndTime)` The date and time when the import job completed.
`DescribeModelVersionResponse.Builder`	`importJobStartTime(Instant importJobStartTime)` The date and time when the import job began.
`default DescribeModelVersionResponse.Builder`	`labelsInputConfiguration(Consumer<LabelsInputConfiguration.Builder> labelsInputConfiguration)` Sets the value of the LabelsInputConfiguration property for this object.
`DescribeModelVersionResponse.Builder`	`labelsInputConfiguration(LabelsInputConfiguration labelsInputConfiguration)` Sets the value of the LabelsInputConfiguration property for this object.
`DescribeModelVersionResponse.Builder`	`lastUpdatedTime(Instant lastUpdatedTime)` Indicates the last time the machine learning model version was updated.
`DescribeModelVersionResponse.Builder`	`modelArn(String modelArn)` The Amazon Resource Name (ARN) of the parent machine learning model that this version belong to.
`DescribeModelVersionResponse.Builder`	`modelMetrics(String modelMetrics)` Shows an aggregated summary, in JSON format, of the model's performance within the evaluation time range.
`DescribeModelVersionResponse.Builder`	`modelName(String modelName)` The name of the machine learning model that this version belongs to.
`DescribeModelVersionResponse.Builder`	`modelVersion(Long modelVersion)` The version of the machine learning model.
`DescribeModelVersionResponse.Builder`	`modelVersionArn(String modelVersionArn)` The Amazon Resource Name (ARN) of the model version.
`DescribeModelVersionResponse.Builder`	`offCondition(String offCondition)` Indicates that the asset associated with this sensor has been shut off.
`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.
`DescribeModelVersionResponse.Builder`	`retrainingAvailableDataInDays(Integer retrainingAvailableDataInDays)` Indicates the number of days of data used in the most recent scheduled retraining run.
`DescribeModelVersionResponse.Builder`	`roleArn(String roleArn)` The Amazon Resource Name (ARN) of the role that was used to train the model version.
`DescribeModelVersionResponse.Builder`	`schema(String schema)` The schema of the data used to train the model version.
`DescribeModelVersionResponse.Builder`	`serverSideKmsKeyId(String serverSideKmsKeyId)` The identifier of the KMS key key used to encrypt model version data by Amazon Lookout for Equipment.
`DescribeModelVersionResponse.Builder`	`sourceModelVersionArn(String sourceModelVersionArn)` If model version was imported, then this field is the arn of the source model version.
`DescribeModelVersionResponse.Builder`	`sourceType(ModelVersionSourceType sourceType)` Indicates whether this model version was created by training or by importing.
`DescribeModelVersionResponse.Builder`	`sourceType(String sourceType)` Indicates whether this model version was created by training or by importing.
`DescribeModelVersionResponse.Builder`	`status(ModelVersionStatus status)` The current status of the model version.
`DescribeModelVersionResponse.Builder`	`status(String status)` The current status of the model version.
`DescribeModelVersionResponse.Builder`	`trainingDataEndTime(Instant trainingDataEndTime)` The date on which the training data finished being gathered.
`DescribeModelVersionResponse.Builder`	`trainingDataStartTime(Instant trainingDataStartTime)` The date on which the training data began being gathered.
`DescribeModelVersionResponse.Builder`	`trainingExecutionEndTime(Instant trainingExecutionEndTime)` The time when the training of the version completed.
`DescribeModelVersionResponse.Builder`	`trainingExecutionStartTime(Instant trainingExecutionStartTime)` The time when the training of the version began.

Methods inherited from interface software.amazon.awssdk.services.lookoutequipment.model.LookoutEquipmentResponse.Builder
build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- 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.
  - status
```
DescribeModelVersionResponse.Builder status(String status)
```
    The current status of the model version.
    
    Parameters:
    
    status - The current status of the model version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ModelVersionStatus, ModelVersionStatus
  - status
```
DescribeModelVersionResponse.Builder status(ModelVersionStatus status)
```
    The current status of the model version.
    
    Parameters:
    
    status - The current status of the model version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ModelVersionStatus, ModelVersionStatus
  - sourceType
```
DescribeModelVersionResponse.Builder sourceType(String sourceType)
```
    Indicates whether this model version was created by training or by importing.
    
    Parameters:
    
    sourceType - Indicates whether this model version was created by training or by importing.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ModelVersionSourceType, ModelVersionSourceType
  - sourceType
```
DescribeModelVersionResponse.Builder sourceType(ModelVersionSourceType sourceType)
```
    Indicates whether this model version was created by training or by importing.
    
    Parameters:
    
    sourceType - Indicates whether this model version was created by training or by importing.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ModelVersionSourceType, ModelVersionSourceType
  - 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.
  - labelsInputConfiguration
```
default DescribeModelVersionResponse.Builder labelsInputConfiguration(Consumer<LabelsInputConfiguration.Builder> labelsInputConfiguration)
```
    Sets the value of the LabelsInputConfiguration property for this object. This is a convenience method that creates an instance of the LabelsInputConfiguration.Builder avoiding the need to create one manually via LabelsInputConfiguration.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to labelsInputConfiguration(LabelsInputConfiguration).
    
    Parameters:
    
    labelsInputConfiguration - a consumer that will call methods on LabelsInputConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    labelsInputConfiguration(LabelsInputConfiguration)
  - 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.
  - dataPreProcessingConfiguration
```
default DescribeModelVersionResponse.Builder dataPreProcessingConfiguration(Consumer<DataPreProcessingConfiguration.Builder> dataPreProcessingConfiguration)
```
    Sets the value of the DataPreProcessingConfiguration property for this object. This is a convenience method that creates an instance of the DataPreProcessingConfiguration.Builder avoiding the need to create one manually via DataPreProcessingConfiguration.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataPreProcessingConfiguration(DataPreProcessingConfiguration).
    
    Parameters:
    
    dataPreProcessingConfiguration - a consumer that will call methods on DataPreProcessingConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    dataPreProcessingConfiguration(DataPreProcessingConfiguration)
  - 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.

Interface DescribeModelVersionResponse.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.lookoutequipment.model.LookoutEquipmentResponse.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

modelName

modelArn

modelVersion

modelVersionArn

status

status

sourceType

sourceType

datasetName

datasetArn

schema

labelsInputConfiguration

labelsInputConfiguration

trainingDataStartTime

trainingDataEndTime

evaluationDataStartTime

evaluationDataEndTime

roleArn

dataPreProcessingConfiguration

dataPreProcessingConfiguration

trainingExecutionStartTime

trainingExecutionEndTime

failedReason

modelMetrics

lastUpdatedTime

createdAt

serverSideKmsKeyId

offCondition

sourceModelVersionArn

importJobStartTime

importJobEndTime

importedDataSizeInBytes

priorModelMetrics

retrainingAvailableDataInDays

autoPromotionResult

autoPromotionResult

autoPromotionResultReason