Class ProjectVersionDescription

java.lang.Object
software.amazon.awssdk.services.rekognition.model.ProjectVersionDescription
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ProjectVersionDescription.Builder,ProjectVersionDescription>
@Generated("software.amazon.awssdk:codegen") public final class ProjectVersionDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ProjectVersionDescription.Builder,ProjectVersionDescription>

A description of a version of a Amazon Rekognition project version.

See Also:

  • Method Details

    • projectVersionArn

      public final String projectVersionArn()

      The Amazon Resource Name (ARN) of the project version.

      Returns:
      The Amazon Resource Name (ARN) of the project version.

    • creationTimestamp

      public final Instant 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

      public final Integer 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

      public final ProjectVersionStatus 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 return ProjectVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the model version.
      See Also:

    • statusAsString

      public final String 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 return ProjectVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the model version.
      See Also:

    • statusMessage

      public final String statusMessage()

      A descriptive message for an error or warning that occurred.

      Returns:
      A descriptive message for an error or warning that occurred.

    • billableTrainingTimeInSeconds

      public final 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.

      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

      public final Instant 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

      public final OutputConfig outputConfig()

      The location where training results are saved.

      Returns:
      The location where training results are saved.

    • trainingDataResult

      public final TrainingDataResult trainingDataResult()

      Contains information about the training results.

      Returns:
      Contains information about the training results.

    • testingDataResult

      public final TestingDataResult testingDataResult()

      Contains information about the testing results.

      Returns:
      Contains information about the testing results.

    • evaluationResult

      public final EvaluationResult 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

      public final GroundTruthManifest 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

      public final String 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

      public final 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.

      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

      public final String 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

      public final String versionDescription()

      A user-provided description of the project version.

      Returns:
      A user-provided description of the project version.

    • feature

      public final CustomizationFeature feature()

      The feature that was customized.

      If the service returns an enum value that is not available in the current SDK version, feature will return CustomizationFeature.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from featureAsString().

      Returns:
      The feature that was customized.
      See Also:

    • featureAsString

      public final String featureAsString()

      The feature that was customized.

      If the service returns an enum value that is not available in the current SDK version, feature will return CustomizationFeature.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from featureAsString().

      Returns:
      The feature that was customized.
      See Also:

    • baseModelVersion

      public final String 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

      public final CustomizationFeatureConfig featureConfig()

      Feature specific configuration that was applied during training.

      Returns:
      Feature specific configuration that was applied during training.

    • toBuilder

      public ProjectVersionDescription.Builder 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 interface ToCopyableBuilder<ProjectVersionDescription.Builder,ProjectVersionDescription>
      Returns:
      a builder for type T

    • builder

      public static ProjectVersionDescription.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ProjectVersionDescription.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.