Interface ProjectVersionDescription.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ProjectVersionDescription.Builder,ProjectVersionDescription>, SdkBuilder<ProjectVersionDescription.Builder,ProjectVersionDescription>, SdkPojo

Enclosing class:

ProjectVersionDescription

public static interface ProjectVersionDescription.Builder
extends SdkPojo, CopyableBuilder<ProjectVersionDescription.Builder,ProjectVersionDescription>

Method Summary

Modifier and Type	Method	Description
ProjectVersionDescription.Builder	baseModelVersion(String baseModelVersion)	The base detection model version used to create the project version.
ProjectVersionDescription.Builder	billableTrainingTimeInSeconds(Long billableTrainingTimeInSeconds)	The duration, in seconds, that you were billed for a successful training of the model version.
ProjectVersionDescription.Builder	creationTimestamp(Instant creationTimestamp)	The Unix datetime for the date and time that training started.
default ProjectVersionDescription.Builder	evaluationResult(Consumer<EvaluationResult.Builder> evaluationResult)	The training results.
ProjectVersionDescription.Builder	evaluationResult(EvaluationResult evaluationResult)	The training results.
ProjectVersionDescription.Builder	feature(String feature)	The feature that was customized.
ProjectVersionDescription.Builder	feature(CustomizationFeature feature)	The feature that was customized.
default ProjectVersionDescription.Builder	featureConfig(Consumer<CustomizationFeatureConfig.Builder> featureConfig)	Feature specific configuration that was applied during training.
ProjectVersionDescription.Builder	featureConfig(CustomizationFeatureConfig featureConfig)	Feature specific configuration that was applied during training.
ProjectVersionDescription.Builder	kmsKeyId(String kmsKeyId)	The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model during training.
default ProjectVersionDescription.Builder	manifestSummary(Consumer<GroundTruthManifest.Builder> manifestSummary)	The location of the summary manifest.
ProjectVersionDescription.Builder	manifestSummary(GroundTruthManifest manifestSummary)	The location of the summary manifest.
ProjectVersionDescription.Builder	maxInferenceUnits(Integer maxInferenceUnits)	The maximum number of inference units Amazon Rekognition uses to auto-scale the model.
ProjectVersionDescription.Builder	minInferenceUnits(Integer minInferenceUnits)	The minimum number of inference units used by the model.
default ProjectVersionDescription.Builder	outputConfig(Consumer<OutputConfig.Builder> outputConfig)	The location where training results are saved.
ProjectVersionDescription.Builder	outputConfig(OutputConfig outputConfig)	The location where training results are saved.
ProjectVersionDescription.Builder	projectVersionArn(String projectVersionArn)	The Amazon Resource Name (ARN) of the project version.
ProjectVersionDescription.Builder	sourceProjectVersionArn(String sourceProjectVersionArn)	If the model version was copied from a different project, SourceProjectVersionArn contains the ARN of the source model version.
ProjectVersionDescription.Builder	status(String status)	The current status of the model version.
ProjectVersionDescription.Builder	status(ProjectVersionStatus status)	The current status of the model version.
ProjectVersionDescription.Builder	statusMessage(String statusMessage)	A descriptive message for an error or warning that occurred.
default ProjectVersionDescription.Builder	testingDataResult(Consumer<TestingDataResult.Builder> testingDataResult)	Contains information about the testing results.
ProjectVersionDescription.Builder	testingDataResult(TestingDataResult testingDataResult)	Contains information about the testing results.
default ProjectVersionDescription.Builder	trainingDataResult(Consumer<TrainingDataResult.Builder> trainingDataResult)	Contains information about the training results.
ProjectVersionDescription.Builder	trainingDataResult(TrainingDataResult trainingDataResult)	Contains information about the training results.
ProjectVersionDescription.Builder	trainingEndTimestamp(Instant trainingEndTimestamp)	The Unix date and time that training of the model ended.
ProjectVersionDescription.Builder	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

ProjectVersionDescription.Builder projectVersionArn(String 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

ProjectVersionDescription.Builder creationTimestamp(Instant 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

ProjectVersionDescription.Builder minInferenceUnits(Integer 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

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

• ProjectVersionStatus
• ProjectVersionStatus

status

ProjectVersionDescription.Builder status(ProjectVersionStatus 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:

• ProjectVersionStatus
• ProjectVersionStatus

statusMessage

ProjectVersionDescription.Builder statusMessage(String 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

ProjectVersionDescription.Builder billableTrainingTimeInSeconds(Long 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

ProjectVersionDescription.Builder trainingEndTimestamp(Instant 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

ProjectVersionDescription.Builder outputConfig(OutputConfig 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

default ProjectVersionDescription.Builder outputConfig(Consumer<OutputConfig.Builder> outputConfig)

The location where training results are saved.

This is a convenience method that creates an instance of the OutputConfig.Builder avoiding the need to create one manually via OutputConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputConfig(OutputConfig).

Parameters:

outputConfig - a consumer that will call methods on OutputConfig.Builder

Returns:

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

See Also:

• outputConfig(OutputConfig)

trainingDataResult

ProjectVersionDescription.Builder trainingDataResult(TrainingDataResult 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 the TrainingDataResult.Builder avoiding the need to create one manually via TrainingDataResult.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to trainingDataResult(TrainingDataResult).

Parameters:

trainingDataResult - a consumer that will call methods on TrainingDataResult.Builder

Returns:

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

See Also:

• trainingDataResult(TrainingDataResult)

testingDataResult

ProjectVersionDescription.Builder testingDataResult(TestingDataResult 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 the TestingDataResult.Builder avoiding the need to create one manually via TestingDataResult.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to testingDataResult(TestingDataResult).

Parameters:

testingDataResult - a consumer that will call methods on TestingDataResult.Builder

Returns:

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

See Also:

• testingDataResult(TestingDataResult)

evaluationResult

ProjectVersionDescription.Builder evaluationResult(EvaluationResult 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. EvaluationResult is only returned if training is successful.

This is a convenience method that creates an instance of the EvaluationResult.Builder avoiding the need to create one manually via EvaluationResult.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to evaluationResult(EvaluationResult).

Parameters:

evaluationResult - a consumer that will call methods on EvaluationResult.Builder

Returns:

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

See Also:

• evaluationResult(EvaluationResult)

manifestSummary

ProjectVersionDescription.Builder manifestSummary(GroundTruthManifest 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 the GroundTruthManifest.Builder avoiding the need to create one manually via GroundTruthManifest.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to manifestSummary(GroundTruthManifest).

Parameters:

manifestSummary - a consumer that will call methods on GroundTruthManifest.Builder

Returns:

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

See Also:

• manifestSummary(GroundTruthManifest)

kmsKeyId

ProjectVersionDescription.Builder kmsKeyId(String 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

ProjectVersionDescription.Builder maxInferenceUnits(Integer 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

ProjectVersionDescription.Builder sourceProjectVersionArn(String 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

ProjectVersionDescription.Builder versionDescription(String 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

ProjectVersionDescription.Builder feature(String 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:

• CustomizationFeature
• CustomizationFeature

feature

ProjectVersionDescription.Builder feature(CustomizationFeature 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:

• CustomizationFeature
• CustomizationFeature

baseModelVersion

ProjectVersionDescription.Builder baseModelVersion(String 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

ProjectVersionDescription.Builder featureConfig(CustomizationFeatureConfig 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 the CustomizationFeatureConfig.Builder avoiding the need to create one manually via CustomizationFeatureConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to featureConfig(CustomizationFeatureConfig).

Parameters:

featureConfig - a consumer that will call methods on CustomizationFeatureConfig.Builder

Returns:

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

See Also:

• featureConfig(CustomizationFeatureConfig)