Interface ModelDescription.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<ModelDescription.Builder,ModelDescription>,SdkBuilder<ModelDescription.Builder,ModelDescription>,SdkPojo
- Enclosing class:
- ModelDescription
public static interface ModelDescription.Builder extends SdkPojo, CopyableBuilder<ModelDescription.Builder,ModelDescription>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description ModelDescription.BuildercreationTimestamp(Instant creationTimestamp)The unix timestamp for the date and time that the model was created.ModelDescription.Builderdescription(String description)The description for the model.ModelDescription.BuilderevaluationEndTimestamp(Instant evaluationEndTimestamp)The unix timestamp for the date and time that the evaluation ended.default ModelDescription.BuilderevaluationManifest(Consumer<OutputS3Object.Builder> evaluationManifest)The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.ModelDescription.BuilderevaluationManifest(OutputS3Object evaluationManifest)The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.default ModelDescription.BuilderevaluationResult(Consumer<OutputS3Object.Builder> evaluationResult)The S3 location where Amazon Lookout for Vision saves the performance metrics.ModelDescription.BuilderevaluationResult(OutputS3Object evaluationResult)The S3 location where Amazon Lookout for Vision saves the performance metrics.ModelDescription.BuilderkmsKeyId(String kmsKeyId)The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.ModelDescription.BuildermaxInferenceUnits(Integer maxInferenceUnits)The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model.ModelDescription.BuilderminInferenceUnits(Integer minInferenceUnits)The minimum number of inference units used by the model.ModelDescription.BuildermodelArn(String modelArn)The Amazon Resource Name (ARN) of the model.ModelDescription.BuildermodelVersion(String modelVersion)The version of the modeldefault ModelDescription.BuilderoutputConfig(Consumer<OutputConfig.Builder> outputConfig)The S3 location where Amazon Lookout for Vision saves model training files.ModelDescription.BuilderoutputConfig(OutputConfig outputConfig)The S3 location where Amazon Lookout for Vision saves model training files.default ModelDescription.Builderperformance(Consumer<ModelPerformance.Builder> performance)Performance metrics for the model.ModelDescription.Builderperformance(ModelPerformance performance)Performance metrics for the model.ModelDescription.Builderstatus(String status)The status of the model.ModelDescription.Builderstatus(ModelStatus status)The status of the model.ModelDescription.BuilderstatusMessage(String statusMessage)The status message for the model.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
modelVersion
ModelDescription.Builder modelVersion(String modelVersion)
The version of the model
- Parameters:
modelVersion- The version of the model- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
modelArn
ModelDescription.Builder modelArn(String modelArn)
The Amazon Resource Name (ARN) of the model.
- Parameters:
modelArn- The Amazon Resource Name (ARN) of the model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
creationTimestamp
ModelDescription.Builder creationTimestamp(Instant creationTimestamp)
The unix timestamp for the date and time that the model was created.
- Parameters:
creationTimestamp- The unix timestamp for the date and time that the model was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
ModelDescription.Builder description(String description)
The description for the model.
- Parameters:
description- The description for the model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
ModelDescription.Builder status(String status)
The status of the model.
- Parameters:
status- The status of the model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ModelStatus,ModelStatus
-
status
ModelDescription.Builder status(ModelStatus status)
The status of the model.
- Parameters:
status- The status of the model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ModelStatus,ModelStatus
-
statusMessage
ModelDescription.Builder statusMessage(String statusMessage)
The status message for the model.
- Parameters:
statusMessage- The status message for the model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
performance
ModelDescription.Builder performance(ModelPerformance performance)
Performance metrics for the model. Created during training.
- Parameters:
performance- Performance metrics for the model. Created during training.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
performance
default ModelDescription.Builder performance(Consumer<ModelPerformance.Builder> performance)
Performance metrics for the model. Created during training.
This is a convenience method that creates an instance of theModelPerformance.Builderavoiding the need to create one manually viaModelPerformance.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toperformance(ModelPerformance).- Parameters:
performance- a consumer that will call methods onModelPerformance.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
performance(ModelPerformance)
-
outputConfig
ModelDescription.Builder outputConfig(OutputConfig outputConfig)
The S3 location where Amazon Lookout for Vision saves model training files.
- Parameters:
outputConfig- The S3 location where Amazon Lookout for Vision saves model training files.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputConfig
default ModelDescription.Builder outputConfig(Consumer<OutputConfig.Builder> outputConfig)
The S3 location where Amazon Lookout for Vision saves model training files.
This is a convenience method that creates an instance of theOutputConfig.Builderavoiding the need to create one manually viaOutputConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tooutputConfig(OutputConfig).- Parameters:
outputConfig- a consumer that will call methods onOutputConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
outputConfig(OutputConfig)
-
evaluationManifest
ModelDescription.Builder evaluationManifest(OutputS3Object evaluationManifest)
The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.
- Parameters:
evaluationManifest- The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
evaluationManifest
default ModelDescription.Builder evaluationManifest(Consumer<OutputS3Object.Builder> evaluationManifest)
The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.
This is a convenience method that creates an instance of theOutputS3Object.Builderavoiding the need to create one manually viaOutputS3Object.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toevaluationManifest(OutputS3Object).- Parameters:
evaluationManifest- a consumer that will call methods onOutputS3Object.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
evaluationManifest(OutputS3Object)
-
evaluationResult
ModelDescription.Builder evaluationResult(OutputS3Object evaluationResult)
The S3 location where Amazon Lookout for Vision saves the performance metrics.
- Parameters:
evaluationResult- The S3 location where Amazon Lookout for Vision saves the performance metrics.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
evaluationResult
default ModelDescription.Builder evaluationResult(Consumer<OutputS3Object.Builder> evaluationResult)
The S3 location where Amazon Lookout for Vision saves the performance metrics.
This is a convenience method that creates an instance of theOutputS3Object.Builderavoiding the need to create one manually viaOutputS3Object.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toevaluationResult(OutputS3Object).- Parameters:
evaluationResult- a consumer that will call methods onOutputS3Object.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
evaluationResult(OutputS3Object)
-
evaluationEndTimestamp
ModelDescription.Builder evaluationEndTimestamp(Instant evaluationEndTimestamp)
The unix timestamp for the date and time that the evaluation ended.
- Parameters:
evaluationEndTimestamp- The unix timestamp for the date and time that the evaluation ended.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyId
ModelDescription.Builder kmsKeyId(String kmsKeyId)
The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.
- Parameters:
kmsKeyId- The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
minInferenceUnits
ModelDescription.Builder minInferenceUnits(Integer minInferenceUnits)
The minimum number of inference units used by the model. For more information, see StartModel
- Parameters:
minInferenceUnits- The minimum number of inference units used by the model. For more information, see StartModel- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxInferenceUnits
ModelDescription.Builder maxInferenceUnits(Integer maxInferenceUnits)
The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more information, see StartModel.
- Parameters:
maxInferenceUnits- The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more information, see StartModel.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-