Interface ProjectVersionDescription.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ProjectVersionDescription.Builder,
,ProjectVersionDescription> SdkBuilder<ProjectVersionDescription.Builder,
,ProjectVersionDescription> SdkPojo
- Enclosing class:
ProjectVersionDescription
-
Method Summary
Modifier and TypeMethodDescriptionbaseModelVersion
(String baseModelVersion) The base detection model version used to create the project version.billableTrainingTimeInSeconds
(Long billableTrainingTimeInSeconds) The duration, in seconds, that you were billed for a successful training of the model version.creationTimestamp
(Instant creationTimestamp) The Unix datetime for the date and time that training started.evaluationResult
(Consumer<EvaluationResult.Builder> evaluationResult) The training results.evaluationResult
(EvaluationResult evaluationResult) The training results.The feature that was customized.feature
(CustomizationFeature feature) The feature that was customized.featureConfig
(Consumer<CustomizationFeatureConfig.Builder> featureConfig) Feature specific configuration that was applied during training.featureConfig
(CustomizationFeatureConfig featureConfig) Feature specific configuration that was applied during training.The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model during training.manifestSummary
(Consumer<GroundTruthManifest.Builder> manifestSummary) The location of the summary manifest.manifestSummary
(GroundTruthManifest manifestSummary) The location of the summary manifest.maxInferenceUnits
(Integer maxInferenceUnits) The maximum number of inference units Amazon Rekognition uses to auto-scale the model.minInferenceUnits
(Integer minInferenceUnits) The minimum number of inference units used by the model.outputConfig
(Consumer<OutputConfig.Builder> outputConfig) The location where training results are saved.outputConfig
(OutputConfig outputConfig) The location where training results are saved.projectVersionArn
(String projectVersionArn) The Amazon Resource Name (ARN) of the project version.sourceProjectVersionArn
(String sourceProjectVersionArn) If the model version was copied from a different project,SourceProjectVersionArn
contains the ARN of the source model version.The current status of the model version.status
(ProjectVersionStatus status) The current status of the model version.statusMessage
(String statusMessage) A descriptive message for an error or warning that occurred.testingDataResult
(Consumer<TestingDataResult.Builder> testingDataResult) Contains information about the testing results.testingDataResult
(TestingDataResult testingDataResult) Contains information about the testing results.trainingDataResult
(Consumer<TrainingDataResult.Builder> trainingDataResult) Contains information about the training results.trainingDataResult
(TrainingDataResult trainingDataResult) Contains information about the training results.trainingEndTimestamp
(Instant trainingEndTimestamp) The Unix date and time that training of the model ended.versionDescription
(String versionDescription) A user-provided description of the project version.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 Details
-
projectVersionArn
The Amazon Resource Name (ARN) of the project version.
- Parameters:
projectVersionArn
- The Amazon Resource Name (ARN) of the project version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
creationTimestamp
The Unix datetime for the date and time that training started.
- Parameters:
creationTimestamp
- The Unix datetime for the date and time that training started.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
minInferenceUnits
The minimum number of inference units used by the model. Applies only to Custom Labels projects. For more information, see StartProjectVersion.
- Parameters:
minInferenceUnits
- The minimum number of inference units used by the model. Applies only to Custom Labels projects. For more information, see StartProjectVersion.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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:
-
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:
-
statusMessage
A descriptive message for an error or warning that occurred.
- Parameters:
statusMessage
- A descriptive message for an error or warning that occurred.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
billableTrainingTimeInSeconds
The duration, in seconds, that you were billed for a successful training of the model version. This value is only returned if the model version has been successfully trained.
- Parameters:
billableTrainingTimeInSeconds
- The duration, in seconds, that you were billed for a successful training of the model version. This value is only returned if the model version has been successfully trained.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trainingEndTimestamp
The Unix date and time that training of the model ended.
- Parameters:
trainingEndTimestamp
- The Unix date and time that training of the model ended.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputConfig
The location where training results are saved.
- Parameters:
outputConfig
- The location where training results are saved.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputConfig
The location where training results are saved.
This is a convenience method that creates an instance of theOutputConfig.Builder
avoiding the need to create one manually viaOutputConfig.builder()
.When the
Consumer
completes,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:
-
trainingDataResult
Contains information about the training results.
- Parameters:
trainingDataResult
- Contains information about the training results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trainingDataResult
default ProjectVersionDescription.Builder trainingDataResult(Consumer<TrainingDataResult.Builder> trainingDataResult) Contains information about the training results.
This is a convenience method that creates an instance of theTrainingDataResult.Builder
avoiding the need to create one manually viaTrainingDataResult.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totrainingDataResult(TrainingDataResult)
.- Parameters:
trainingDataResult
- a consumer that will call methods onTrainingDataResult.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
testingDataResult
Contains information about the testing results.
- Parameters:
testingDataResult
- Contains information about the testing results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
testingDataResult
default ProjectVersionDescription.Builder testingDataResult(Consumer<TestingDataResult.Builder> testingDataResult) Contains information about the testing results.
This is a convenience method that creates an instance of theTestingDataResult.Builder
avoiding the need to create one manually viaTestingDataResult.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totestingDataResult(TestingDataResult)
.- Parameters:
testingDataResult
- a consumer that will call methods onTestingDataResult.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
evaluationResult
The training results.
EvaluationResult
is only returned if training is successful.- Parameters:
evaluationResult
- The training results.EvaluationResult
is only returned if training is successful.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
evaluationResult
default ProjectVersionDescription.Builder evaluationResult(Consumer<EvaluationResult.Builder> evaluationResult) The training results.
This is a convenience method that creates an instance of theEvaluationResult
is only returned if training is successful.EvaluationResult.Builder
avoiding the need to create one manually viaEvaluationResult.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toevaluationResult(EvaluationResult)
.- Parameters:
evaluationResult
- a consumer that will call methods onEvaluationResult.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
manifestSummary
The location of the summary manifest. The summary manifest provides aggregate data validation results for the training and test datasets.
- Parameters:
manifestSummary
- The location of the summary manifest. The summary manifest provides aggregate data validation results for the training and test datasets.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
manifestSummary
default ProjectVersionDescription.Builder manifestSummary(Consumer<GroundTruthManifest.Builder> manifestSummary) The location of the summary manifest. The summary manifest provides aggregate data validation results for the training and test datasets.
This is a convenience method that creates an instance of theGroundTruthManifest.Builder
avoiding the need to create one manually viaGroundTruthManifest.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomanifestSummary(GroundTruthManifest)
.- Parameters:
manifestSummary
- a consumer that will call methods onGroundTruthManifest.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
kmsKeyId
The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model during training.
- Parameters:
kmsKeyId
- The identifer for the AWS Key Management Service key (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.
-
maxInferenceUnits
The maximum number of inference units Amazon Rekognition uses to auto-scale the model. Applies only to Custom Labels projects. For more information, see StartProjectVersion.
- Parameters:
maxInferenceUnits
- The maximum number of inference units Amazon Rekognition uses to auto-scale the model. Applies only to Custom Labels projects. For more information, see StartProjectVersion.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceProjectVersionArn
If the model version was copied from a different project,
SourceProjectVersionArn
contains the ARN of the source model version.- Parameters:
sourceProjectVersionArn
- If the model version was copied from a different project,SourceProjectVersionArn
contains the ARN of the source model version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
versionDescription
A user-provided description of the project version.
- Parameters:
versionDescription
- A user-provided description of the project version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
feature
The feature that was customized.
- Parameters:
feature
- The feature that was customized.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
feature
The feature that was customized.
- Parameters:
feature
- The feature that was customized.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
baseModelVersion
The base detection model version used to create the project version.
- Parameters:
baseModelVersion
- The base detection model version used to create the project version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
featureConfig
Feature specific configuration that was applied during training.
- Parameters:
featureConfig
- Feature specific configuration that was applied during training.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
featureConfig
default ProjectVersionDescription.Builder featureConfig(Consumer<CustomizationFeatureConfig.Builder> featureConfig) Feature specific configuration that was applied during training.
This is a convenience method that creates an instance of theCustomizationFeatureConfig.Builder
avoiding the need to create one manually viaCustomizationFeatureConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofeatureConfig(CustomizationFeatureConfig)
.- Parameters:
featureConfig
- a consumer that will call methods onCustomizationFeatureConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-