ModelDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.lookoutforvision.model.ModelDescription

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Describes an Amazon Lookout for Vision model.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ModelDescription()

Constructors
Constructor and Description
`ModelDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ModelDescription`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTimestamp()` The unix timestamp for the date and time that the model was created.
`String`	`getDescription()` The description for the model.
`Date`	`getEvaluationEndTimestamp()` The unix timestamp for the date and time that the evaluation ended.
`OutputS3Object`	`getEvaluationManifest()` The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.
`OutputS3Object`	`getEvaluationResult()` The S3 location where Amazon Lookout for Vision saves the performance metrics.
`String`	`getKmsKeyId()` The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.
`Integer`	`getMaxInferenceUnits()` The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model.
`Integer`	`getMinInferenceUnits()` The minimum number of inference units used by the model.
`String`	`getModelArn()` The Amazon Resource Name (ARN) of the model.
`String`	`getModelVersion()` The version of the model
`OutputConfig`	`getOutputConfig()` The S3 location where Amazon Lookout for Vision saves model training files.
`ModelPerformance`	`getPerformance()` Performance metrics for the model.
`String`	`getStatus()` The status of the model.
`String`	`getStatusMessage()` The status message for the model.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreationTimestamp(Date creationTimestamp)` The unix timestamp for the date and time that the model was created.
`void`	`setDescription(String description)` The description for the model.
`void`	`setEvaluationEndTimestamp(Date evaluationEndTimestamp)` The unix timestamp for the date and time that the evaluation ended.
`void`	`setEvaluationManifest(OutputS3Object evaluationManifest)` The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.
`void`	`setEvaluationResult(OutputS3Object evaluationResult)` The S3 location where Amazon Lookout for Vision saves the performance metrics.
`void`	`setKmsKeyId(String kmsKeyId)` The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.
`void`	`setMaxInferenceUnits(Integer maxInferenceUnits)` The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model.
`void`	`setMinInferenceUnits(Integer minInferenceUnits)` The minimum number of inference units used by the model.
`void`	`setModelArn(String modelArn)` The Amazon Resource Name (ARN) of the model.
`void`	`setModelVersion(String modelVersion)` The version of the model
`void`	`setOutputConfig(OutputConfig outputConfig)` The S3 location where Amazon Lookout for Vision saves model training files.
`void`	`setPerformance(ModelPerformance performance)` Performance metrics for the model.
`void`	`setStatus(String status)` The status of the model.
`void`	`setStatusMessage(String statusMessage)` The status message for the model.
`String`	`toString()` Returns a string representation of this object.
`ModelDescription`	`withCreationTimestamp(Date creationTimestamp)` The unix timestamp for the date and time that the model was created.
`ModelDescription`	`withDescription(String description)` The description for the model.
`ModelDescription`	`withEvaluationEndTimestamp(Date evaluationEndTimestamp)` The unix timestamp for the date and time that the evaluation ended.
`ModelDescription`	`withEvaluationManifest(OutputS3Object evaluationManifest)` The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.
`ModelDescription`	`withEvaluationResult(OutputS3Object evaluationResult)` The S3 location where Amazon Lookout for Vision saves the performance metrics.
`ModelDescription`	`withKmsKeyId(String kmsKeyId)` The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.
`ModelDescription`	`withMaxInferenceUnits(Integer maxInferenceUnits)` The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model.
`ModelDescription`	`withMinInferenceUnits(Integer minInferenceUnits)` The minimum number of inference units used by the model.
`ModelDescription`	`withModelArn(String modelArn)` The Amazon Resource Name (ARN) of the model.
`ModelDescription`	`withModelVersion(String modelVersion)` The version of the model
`ModelDescription`	`withOutputConfig(OutputConfig outputConfig)` The S3 location where Amazon Lookout for Vision saves model training files.
`ModelDescription`	`withPerformance(ModelPerformance performance)` Performance metrics for the model.
`ModelDescription`	`withStatus(ModelStatus status)` The status of the model.
`ModelDescription`	`withStatus(String status)` The status of the model.
`ModelDescription`	`withStatusMessage(String statusMessage)` The status message for the model.

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

- Constructor Detail
  - ModelDescription
```
public ModelDescription()
```
- Method Detail
  - setModelVersion
```
public void setModelVersion(String modelVersion)
```
    The version of the model
    
    Parameters:
    
    modelVersion - The version of the model
  - getModelVersion
```
public String getModelVersion()
```
    The version of the model
    
    Returns:
    
    The version of the model
  - withModelVersion
```
public ModelDescription withModelVersion(String modelVersion)
```
    The version of the model
    
    Parameters:
    
    modelVersion - The version of the model
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelArn
```
public void setModelArn(String modelArn)
```
    The Amazon Resource Name (ARN) of the model.
    
    Parameters:
    
    modelArn - The Amazon Resource Name (ARN) of the model.
  - getModelArn
```
public String getModelArn()
```
    The Amazon Resource Name (ARN) of the model.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the model.
  - withModelArn
```
public ModelDescription withModelArn(String modelArn)
```
    The Amazon Resource Name (ARN) of the model.
    
    Parameters:
    
    modelArn - The Amazon Resource Name (ARN) of the model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTimestamp
```
public void setCreationTimestamp(Date creationTimestamp)
```
    The unix timestamp for the date and time that the model was created.
    
    Parameters:
    
    creationTimestamp - The unix timestamp for the date and time that the model was created.
  - getCreationTimestamp
```
public Date getCreationTimestamp()
```
    The unix timestamp for the date and time that the model was created.
    
    Returns:
    
    The unix timestamp for the date and time that the model was created.
  - withCreationTimestamp
```
public ModelDescription withCreationTimestamp(Date creationTimestamp)
```
    The unix timestamp for the date and time that the model was created.
    
    Parameters:
    
    creationTimestamp - The unix timestamp for the date and time that the model was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description for the model.
    
    Parameters:
    
    description - The description for the model.
  - getDescription
```
public String getDescription()
```
    The description for the model.
    
    Returns:
    
    The description for the model.
  - withDescription
```
public ModelDescription withDescription(String description)
```
    The description for the model.
    
    Parameters:
    
    description - The description for the model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the model.
    
    Parameters:
    
    status - The status of the model.
    
    See Also:
    
    ModelStatus
  - getStatus
```
public String getStatus()
```
    The status of the model.
    
    Returns:
    
    The status of the model.
    
    See Also:
    
    ModelStatus
  - withStatus
```
public ModelDescription withStatus(String status)
```
    The status of the model.
    
    Parameters:
    
    status - The status of the model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ModelStatus
  - withStatus
```
public ModelDescription withStatus(ModelStatus status)
```
    The status of the model.
    
    Parameters:
    
    status - The status of the model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ModelStatus
  - setStatusMessage
```
public void setStatusMessage(String statusMessage)
```
    The status message for the model.
    
    Parameters:
    
    statusMessage - The status message for the model.
  - getStatusMessage
```
public String getStatusMessage()
```
    The status message for the model.
    
    Returns:
    
    The status message for the model.
  - withStatusMessage
```
public ModelDescription withStatusMessage(String statusMessage)
```
    The status message for the model.
    
    Parameters:
    
    statusMessage - The status message for the model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPerformance
```
public void setPerformance(ModelPerformance performance)
```
    Performance metrics for the model. Created during training.
    
    Parameters:
    
    performance - Performance metrics for the model. Created during training.
  - getPerformance
```
public ModelPerformance getPerformance()
```
    Performance metrics for the model. Created during training.
    
    Returns:
    
    Performance metrics for the model. Created during training.
  - withPerformance
```
public ModelDescription withPerformance(ModelPerformance performance)
```
    Performance metrics for the model. Created during training.
    
    Parameters:
    
    performance - Performance metrics for the model. Created during training.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputConfig
```
public void setOutputConfig(OutputConfig outputConfig)
```
    The S3 location where Amazon Lookout for Vision saves model training files.
    
    Parameters:
    
    outputConfig - The S3 location where Amazon Lookout for Vision saves model training files.
  - getOutputConfig
```
public OutputConfig getOutputConfig()
```
    The S3 location where Amazon Lookout for Vision saves model training files.
    
    Returns:
    
    The S3 location where Amazon Lookout for Vision saves model training files.
  - withOutputConfig
```
public ModelDescription withOutputConfig(OutputConfig outputConfig)
```
    The S3 location where Amazon Lookout for Vision saves model training files.
    
    Parameters:
    
    outputConfig - The S3 location where Amazon Lookout for Vision saves model training files.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEvaluationManifest
```
public void setEvaluationManifest(OutputS3Object evaluationManifest)
```
    The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.
    
    Parameters:
    
    evaluationManifest - The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.
  - getEvaluationManifest
```
public OutputS3Object getEvaluationManifest()
```
    The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.
    
    Returns:
    
    The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.
  - withEvaluationManifest
```
public ModelDescription withEvaluationManifest(OutputS3Object evaluationManifest)
```
    The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.
    
    Parameters:
    
    evaluationManifest - The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEvaluationResult
```
public void setEvaluationResult(OutputS3Object evaluationResult)
```
    The S3 location where Amazon Lookout for Vision saves the performance metrics.
    
    Parameters:
    
    evaluationResult - The S3 location where Amazon Lookout for Vision saves the performance metrics.
  - getEvaluationResult
```
public OutputS3Object getEvaluationResult()
```
    The S3 location where Amazon Lookout for Vision saves the performance metrics.
    
    Returns:
    
    The S3 location where Amazon Lookout for Vision saves the performance metrics.
  - withEvaluationResult
```
public ModelDescription withEvaluationResult(OutputS3Object evaluationResult)
```
    The S3 location where Amazon Lookout for Vision saves the performance metrics.
    
    Parameters:
    
    evaluationResult - The S3 location where Amazon Lookout for Vision saves the performance metrics.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEvaluationEndTimestamp
```
public void setEvaluationEndTimestamp(Date evaluationEndTimestamp)
```
    The unix timestamp for the date and time that the evaluation ended.
    
    Parameters:
    
    evaluationEndTimestamp - The unix timestamp for the date and time that the evaluation ended.
  - getEvaluationEndTimestamp
```
public Date getEvaluationEndTimestamp()
```
    The unix timestamp for the date and time that the evaluation ended.
    
    Returns:
    
    The unix timestamp for the date and time that the evaluation ended.
  - withEvaluationEndTimestamp
```
public ModelDescription withEvaluationEndTimestamp(Date evaluationEndTimestamp)
```
    The unix timestamp for the date and time that the evaluation ended.
    
    Parameters:
    
    evaluationEndTimestamp - The unix timestamp for the date and time that the evaluation ended.
    
    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 (AWS KMS) key that was used to encrypt the model during training.
    
    Parameters:
    
    kmsKeyId - The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.
    
    Returns:
    
    The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.
  - withKmsKeyId
```
public ModelDescription withKmsKeyId(String kmsKeyId)
```
    The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.
    
    Parameters:
    
    kmsKeyId - The identifer for the AWS Key Management Service (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.
  - setMinInferenceUnits
```
public void setMinInferenceUnits(Integer minInferenceUnits)
```
    The minimum number of inference units used by the model. For more information, see StartModel
    
    Parameters:
    
    minInferenceUnits - The minimum number of inference units used by the model. For more information, see StartModel
  - getMinInferenceUnits
```
public Integer getMinInferenceUnits()
```
    The minimum number of inference units used by the model. For more information, see StartModel
    
    Returns:
    
    The minimum number of inference units used by the model. For more information, see StartModel
  - withMinInferenceUnits
```
public ModelDescription withMinInferenceUnits(Integer minInferenceUnits)
```
    The minimum number of inference units used by the model. For more information, see StartModel
    
    Parameters:
    
    minInferenceUnits - The minimum number of inference units used by the model. For more information, see StartModel
    
    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 Lookout for Vision uses to auto-scale the model. For more information, see StartModel.
    
    Parameters:
    
    maxInferenceUnits - The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more information, see StartModel.
  - getMaxInferenceUnits
```
public Integer getMaxInferenceUnits()
```
    The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more information, see StartModel.
    
    Returns:
    
    The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more information, see StartModel.
  - withMaxInferenceUnits
```
public ModelDescription withMaxInferenceUnits(Integer maxInferenceUnits)
```
    The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more information, see StartModel.
    
    Parameters:
    
    maxInferenceUnits - The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more information, see StartModel.
    
    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 ModelDescription 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.

AWS SDK for Java 1.x API Reference - 1.12.782

Class ModelDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ModelDescription

Method Detail

setModelVersion

getModelVersion

withModelVersion

setModelArn

getModelArn

withModelArn

setCreationTimestamp

getCreationTimestamp

withCreationTimestamp

setDescription

getDescription

withDescription

setStatus

getStatus

withStatus

withStatus

setStatusMessage

getStatusMessage

withStatusMessage

setPerformance

getPerformance

withPerformance

setOutputConfig

getOutputConfig

withOutputConfig

setEvaluationManifest

getEvaluationManifest

withEvaluationManifest

setEvaluationResult

getEvaluationResult

withEvaluationResult

setEvaluationEndTimestamp

getEvaluationEndTimestamp

withEvaluationEndTimestamp

setKmsKeyId

getKmsKeyId

withKmsKeyId

setMinInferenceUnits

getMinInferenceUnits

withMinInferenceUnits

setMaxInferenceUnits

getMaxInferenceUnits

withMaxInferenceUnits

toString

equals

hashCode

clone

marshall