Class ProjectVersionDescription
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ProjectVersionDescription.Builder,
ProjectVersionDescription>
A description of a version of a Amazon Rekognition project version.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The base detection model version used to create the project version.final Long
The duration, in seconds, that you were billed for a successful training of the model version.builder()
final Instant
The Unix datetime for the date and time that training started.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final EvaluationResult
The training results.final CustomizationFeature
feature()
The feature that was customized.final String
The feature that was customized.Feature specific configuration that was applied during training.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
kmsKeyId()
The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model during training.final GroundTruthManifest
The location of the summary manifest.final Integer
The maximum number of inference units Amazon Rekognition uses to auto-scale the model.final Integer
The minimum number of inference units used by the model.final OutputConfig
The location where training results are saved.final String
The Amazon Resource Name (ARN) of the project version.static Class
<? extends ProjectVersionDescription.Builder> final String
If the model version was copied from a different project,SourceProjectVersionArn
contains the ARN of the source model version.final ProjectVersionStatus
status()
The current status of the model version.final String
The current status of the model version.final String
A descriptive message for an error or warning that occurred.final TestingDataResult
Contains information about the testing results.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final TrainingDataResult
Contains information about the training results.final Instant
The Unix date and time that training of the model ended.final String
A user-provided description of the project version.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
projectVersionArn
The Amazon Resource Name (ARN) of the project version.
- Returns:
- The Amazon Resource Name (ARN) of the project version.
-
creationTimestamp
The Unix datetime for the date and time that training started.
- Returns:
- The Unix datetime for the date and time that training started.
-
minInferenceUnits
The minimum number of inference units used by the model. Applies only to Custom Labels projects. For more information, see StartProjectVersion.
- Returns:
- The minimum number of inference units used by the model. Applies only to Custom Labels projects. For more information, see StartProjectVersion.
-
status
The current status of the model version.
If the service returns an enum value that is not available in the current SDK version,
status
will returnProjectVersionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the model version.
- See Also:
-
statusAsString
The current status of the model version.
If the service returns an enum value that is not available in the current SDK version,
status
will returnProjectVersionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the model version.
- See Also:
-
statusMessage
A descriptive message for an error or warning that occurred.
- Returns:
- A descriptive message for an error or warning that occurred.
-
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:
- 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.
-
trainingEndTimestamp
The Unix date and time that training of the model ended.
- Returns:
- The Unix date and time that training of the model ended.
-
outputConfig
The location where training results are saved.
- Returns:
- The location where training results are saved.
-
trainingDataResult
Contains information about the training results.
- Returns:
- Contains information about the training results.
-
testingDataResult
Contains information about the testing results.
- Returns:
- Contains information about the testing results.
-
evaluationResult
The training results.
EvaluationResult
is only returned if training is successful.- Returns:
- The training results.
EvaluationResult
is only returned if training is successful.
-
manifestSummary
The location of the summary manifest. The summary manifest provides aggregate data validation results for the training and test datasets.
- Returns:
- The location of the summary manifest. The summary manifest provides aggregate data validation results for the training and test datasets.
-
kmsKeyId
The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model during training.
- Returns:
- The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model during training.
-
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:
- 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.
-
sourceProjectVersionArn
If the model version was copied from a different project,
SourceProjectVersionArn
contains the ARN of the source model version.- Returns:
- If the model version was copied from a different project,
SourceProjectVersionArn
contains the ARN of the source model version.
-
versionDescription
A user-provided description of the project version.
- Returns:
- A user-provided description of the project version.
-
feature
The feature that was customized.
If the service returns an enum value that is not available in the current SDK version,
feature
will returnCustomizationFeature.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfeatureAsString()
.- Returns:
- The feature that was customized.
- See Also:
-
featureAsString
The feature that was customized.
If the service returns an enum value that is not available in the current SDK version,
feature
will returnCustomizationFeature.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfeatureAsString()
.- Returns:
- The feature that was customized.
- See Also:
-
baseModelVersion
The base detection model version used to create the project version.
- Returns:
- The base detection model version used to create the project version.
-
featureConfig
Feature specific configuration that was applied during training.
- Returns:
- Feature specific configuration that was applied during training.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ProjectVersionDescription.Builder,
ProjectVersionDescription> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-