ProjectVersionDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.rekognition.model.ProjectVersionDescription

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ProjectVersionDescription
extends Object
implements Serializable, Cloneable, StructuredPojo

A description of a version of an Amazon Rekognition Custom Labels model.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

ProjectVersionDescription()

Constructors
Constructor and Description
`ProjectVersionDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProjectVersionDescription`	`clone()`
`boolean`	`equals(Object obj)`
`Long`	`getBillableTrainingTimeInSeconds()` The duration, in seconds, that you were billed for a successful training of the model version.
`Date`	`getCreationTimestamp()` The Unix datetime for the date and time that training started.
`EvaluationResult`	`getEvaluationResult()` The training results.
`String`	`getKmsKeyId()` The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model during training.
`GroundTruthManifest`	`getManifestSummary()` The location of the summary manifest.
`Integer`	`getMaxInferenceUnits()` The maximum number of inference units Amazon Rekognition Custom Labels uses to auto-scale the model.
`Integer`	`getMinInferenceUnits()` The minimum number of inference units used by the model.
`OutputConfig`	`getOutputConfig()` The location where training results are saved.
`String`	`getProjectVersionArn()` The Amazon Resource Name (ARN) of the model version.
`String`	`getSourceProjectVersionArn()` If the model version was copied from a different project, `SourceProjectVersionArn` contains the ARN of the source model version.
`String`	`getStatus()` The current status of the model version.
`String`	`getStatusMessage()` A descriptive message for an error or warning that occurred.
`TestingDataResult`	`getTestingDataResult()` Contains information about the testing results.
`TrainingDataResult`	`getTrainingDataResult()` Contains information about the training results.
`Date`	`getTrainingEndTimestamp()` The Unix date and time that training of the model ended.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBillableTrainingTimeInSeconds(Long billableTrainingTimeInSeconds)` The duration, in seconds, that you were billed for a successful training of the model version.
`void`	`setCreationTimestamp(Date creationTimestamp)` The Unix datetime for the date and time that training started.
`void`	`setEvaluationResult(EvaluationResult evaluationResult)` The training results.
`void`	`setKmsKeyId(String kmsKeyId)` The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model during training.
`void`	`setManifestSummary(GroundTruthManifest manifestSummary)` The location of the summary manifest.
`void`	`setMaxInferenceUnits(Integer maxInferenceUnits)` The maximum number of inference units Amazon Rekognition Custom Labels uses to auto-scale the model.
`void`	`setMinInferenceUnits(Integer minInferenceUnits)` The minimum number of inference units used by the model.
`void`	`setOutputConfig(OutputConfig outputConfig)` The location where training results are saved.
`void`	`setProjectVersionArn(String projectVersionArn)` The Amazon Resource Name (ARN) of the model version.
`void`	`setSourceProjectVersionArn(String sourceProjectVersionArn)` If the model version was copied from a different project, `SourceProjectVersionArn` contains the ARN of the source model version.
`void`	`setStatus(String status)` The current status of the model version.
`void`	`setStatusMessage(String statusMessage)` A descriptive message for an error or warning that occurred.
`void`	`setTestingDataResult(TestingDataResult testingDataResult)` Contains information about the testing results.
`void`	`setTrainingDataResult(TrainingDataResult trainingDataResult)` Contains information about the training results.
`void`	`setTrainingEndTimestamp(Date trainingEndTimestamp)` The Unix date and time that training of the model ended.
`String`	`toString()` Returns a string representation of this object.
`ProjectVersionDescription`	`withBillableTrainingTimeInSeconds(Long billableTrainingTimeInSeconds)` The duration, in seconds, that you were billed for a successful training of the model version.
`ProjectVersionDescription`	`withCreationTimestamp(Date creationTimestamp)` The Unix datetime for the date and time that training started.
`ProjectVersionDescription`	`withEvaluationResult(EvaluationResult evaluationResult)` The training results.
`ProjectVersionDescription`	`withKmsKeyId(String kmsKeyId)` The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model during training.
`ProjectVersionDescription`	`withManifestSummary(GroundTruthManifest manifestSummary)` The location of the summary manifest.
`ProjectVersionDescription`	`withMaxInferenceUnits(Integer maxInferenceUnits)` The maximum number of inference units Amazon Rekognition Custom Labels uses to auto-scale the model.
`ProjectVersionDescription`	`withMinInferenceUnits(Integer minInferenceUnits)` The minimum number of inference units used by the model.
`ProjectVersionDescription`	`withOutputConfig(OutputConfig outputConfig)` The location where training results are saved.
`ProjectVersionDescription`	`withProjectVersionArn(String projectVersionArn)` The Amazon Resource Name (ARN) of the model version.
`ProjectVersionDescription`	`withSourceProjectVersionArn(String sourceProjectVersionArn)` If the model version was copied from a different project, `SourceProjectVersionArn` contains the ARN of the source model version.
`ProjectVersionDescription`	`withStatus(ProjectVersionStatus status)` The current status of the model version.
`ProjectVersionDescription`	`withStatus(String status)` The current status of the model version.
`ProjectVersionDescription`	`withStatusMessage(String statusMessage)` A descriptive message for an error or warning that occurred.
`ProjectVersionDescription`	`withTestingDataResult(TestingDataResult testingDataResult)` Contains information about the testing results.
`ProjectVersionDescription`	`withTrainingDataResult(TrainingDataResult trainingDataResult)` Contains information about the training results.
`ProjectVersionDescription`	`withTrainingEndTimestamp(Date trainingEndTimestamp)` The Unix date and time that training of the model ended.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ProjectVersionDescription
```
public ProjectVersionDescription()
```
- Method Detail
  - setProjectVersionArn
```
public void setProjectVersionArn(String projectVersionArn)
```
    The Amazon Resource Name (ARN) of the model version.
    
    Parameters:
    
    projectVersionArn - The Amazon Resource Name (ARN) of the model version.
  - getProjectVersionArn
```
public String getProjectVersionArn()
```
    The Amazon Resource Name (ARN) of the model version.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the model version.
  - withProjectVersionArn
```
public ProjectVersionDescription withProjectVersionArn(String projectVersionArn)
```
    The Amazon Resource Name (ARN) of the model version.
    
    Parameters:
    
    projectVersionArn - The Amazon Resource Name (ARN) of the model version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTimestamp
```
public void setCreationTimestamp(Date 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.
  - getCreationTimestamp
```
public Date getCreationTimestamp()
```
    The Unix datetime for the date and time that training started.
    
    Returns:
    
    The Unix datetime for the date and time that training started.
  - withCreationTimestamp
```
public ProjectVersionDescription withCreationTimestamp(Date 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.
  - setMinInferenceUnits
```
public void setMinInferenceUnits(Integer minInferenceUnits)
```
    The minimum number of inference units used by the model. For more information, see StartProjectVersion.
    
    Parameters:
    
    minInferenceUnits - The minimum number of inference units used by the model. For more information, see StartProjectVersion.
  - getMinInferenceUnits
```
public Integer getMinInferenceUnits()
```
    The minimum number of inference units used by the model. For more information, see StartProjectVersion.
    
    Returns:
    
    The minimum number of inference units used by the model. For more information, see StartProjectVersion.
  - withMinInferenceUnits
```
public ProjectVersionDescription withMinInferenceUnits(Integer minInferenceUnits)
```
    The minimum number of inference units used by the model. For more information, see StartProjectVersion.
    
    Parameters:
    
    minInferenceUnits - The minimum number of inference units used by the model. For more information, see StartProjectVersion.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The current status of the model version.
    
    Parameters:
    
    status - The current status of the model version.
    
    See Also:
    
    ProjectVersionStatus
  - getStatus
```
public String getStatus()
```
    The current status of the model version.
    
    Returns:
    
    The current status of the model version.
    
    See Also:
    
    ProjectVersionStatus
  - withStatus
```
public ProjectVersionDescription withStatus(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
  - withStatus
```
public ProjectVersionDescription withStatus(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
  - setStatusMessage
```
public void setStatusMessage(String statusMessage)
```
    A descriptive message for an error or warning that occurred.
    
    Parameters:
    
    statusMessage - A descriptive message for an error or warning that occurred.
  - getStatusMessage
```
public String getStatusMessage()
```
    A descriptive message for an error or warning that occurred.
    
    Returns:
    
    A descriptive message for an error or warning that occurred.
  - withStatusMessage
```
public ProjectVersionDescription withStatusMessage(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.
  - setBillableTrainingTimeInSeconds
```
public void setBillableTrainingTimeInSeconds(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.
  - getBillableTrainingTimeInSeconds
```
public Long getBillableTrainingTimeInSeconds()
```
    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.
  - withBillableTrainingTimeInSeconds
```
public ProjectVersionDescription withBillableTrainingTimeInSeconds(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.
  - setTrainingEndTimestamp
```
public void setTrainingEndTimestamp(Date 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.
  - getTrainingEndTimestamp
```
public Date getTrainingEndTimestamp()
```
    The Unix date and time that training of the model ended.
    
    Returns:
    
    The Unix date and time that training of the model ended.
  - withTrainingEndTimestamp
```
public ProjectVersionDescription withTrainingEndTimestamp(Date 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.
  - setOutputConfig
```
public void setOutputConfig(OutputConfig outputConfig)
```
    The location where training results are saved.
    
    Parameters:
    
    outputConfig - The location where training results are saved.
  - getOutputConfig
```
public OutputConfig getOutputConfig()
```
    The location where training results are saved.
    
    Returns:
    
    The location where training results are saved.
  - withOutputConfig
```
public ProjectVersionDescription withOutputConfig(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.
  - setTrainingDataResult
```
public void setTrainingDataResult(TrainingDataResult trainingDataResult)
```
    Contains information about the training results.
    
    Parameters:
    
    trainingDataResult - Contains information about the training results.
  - getTrainingDataResult
```
public TrainingDataResult getTrainingDataResult()
```
    Contains information about the training results.
    
    Returns:
    
    Contains information about the training results.
  - withTrainingDataResult
```
public ProjectVersionDescription withTrainingDataResult(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.
  - setTestingDataResult
```
public void setTestingDataResult(TestingDataResult testingDataResult)
```
    Contains information about the testing results.
    
    Parameters:
    
    testingDataResult - Contains information about the testing results.
  - getTestingDataResult
```
public TestingDataResult getTestingDataResult()
```
    Contains information about the testing results.
    
    Returns:
    
    Contains information about the testing results.
  - withTestingDataResult
```
public ProjectVersionDescription withTestingDataResult(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.
  - setEvaluationResult
```
public void setEvaluationResult(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.
  - getEvaluationResult
```
public EvaluationResult getEvaluationResult()
```
    The training results. EvaluationResult is only returned if training is successful.
    
    Returns:
    
    The training results. EvaluationResult is only returned if training is successful.
  - withEvaluationResult
```
public ProjectVersionDescription withEvaluationResult(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.
  - setManifestSummary
```
public void setManifestSummary(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.
  - getManifestSummary
```
public GroundTruthManifest getManifestSummary()
```
    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.
  - withManifestSummary
```
public ProjectVersionDescription withManifestSummary(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.
  - setKmsKeyId
```
public void setKmsKeyId(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.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    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.
  - withKmsKeyId
```
public ProjectVersionDescription withKmsKeyId(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.
  - setMaxInferenceUnits
```
public void setMaxInferenceUnits(Integer maxInferenceUnits)
```
    The maximum number of inference units Amazon Rekognition Custom Labels uses to auto-scale the model. For more information, see StartProjectVersion.
    
    Parameters:
    
    maxInferenceUnits - The maximum number of inference units Amazon Rekognition Custom Labels uses to auto-scale the model. For more information, see StartProjectVersion.
  - getMaxInferenceUnits
```
public Integer getMaxInferenceUnits()
```
    The maximum number of inference units Amazon Rekognition Custom Labels uses to auto-scale the model. For more information, see StartProjectVersion.
    
    Returns:
    
    The maximum number of inference units Amazon Rekognition Custom Labels uses to auto-scale the model. For more information, see StartProjectVersion.
  - withMaxInferenceUnits
```
public ProjectVersionDescription withMaxInferenceUnits(Integer maxInferenceUnits)
```
    The maximum number of inference units Amazon Rekognition Custom Labels uses to auto-scale the model. For more information, see StartProjectVersion.
    
    Parameters:
    
    maxInferenceUnits - The maximum number of inference units Amazon Rekognition Custom Labels uses to auto-scale the model. For more information, see StartProjectVersion.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceProjectVersionArn
```
public void setSourceProjectVersionArn(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.
  - getSourceProjectVersionArn
```
public String getSourceProjectVersionArn()
```
    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.
  - withSourceProjectVersionArn
```
public ProjectVersionDescription withSourceProjectVersionArn(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ProjectVersionDescription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ProjectVersionDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProjectVersionDescription

Method Detail

setProjectVersionArn

getProjectVersionArn

withProjectVersionArn

setCreationTimestamp

getCreationTimestamp

withCreationTimestamp

setMinInferenceUnits

getMinInferenceUnits

withMinInferenceUnits

setStatus

getStatus

withStatus

withStatus

setStatusMessage

getStatusMessage

withStatusMessage

setBillableTrainingTimeInSeconds

getBillableTrainingTimeInSeconds

withBillableTrainingTimeInSeconds

setTrainingEndTimestamp

getTrainingEndTimestamp

withTrainingEndTimestamp

setOutputConfig

getOutputConfig

withOutputConfig

setTrainingDataResult

getTrainingDataResult

withTrainingDataResult

setTestingDataResult

getTestingDataResult

withTestingDataResult

setEvaluationResult

getEvaluationResult

withEvaluationResult

setManifestSummary

getManifestSummary

withManifestSummary

setKmsKeyId

getKmsKeyId

withKmsKeyId

setMaxInferenceUnits

getMaxInferenceUnits

withMaxInferenceUnits

setSourceProjectVersionArn

getSourceProjectVersionArn

withSourceProjectVersionArn

toString

equals

hashCode

clone

marshall