com.amazonaws.services.lookoutforvision.model.ModelDescription Maven / Gradle / Ivy
Show all versions of aws-java-sdk-lookoutforvision Show documentation
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.lookoutforvision.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Describes an Amazon Lookout for Vision model.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ModelDescription implements Serializable, Cloneable, StructuredPojo {
/**
*
* The version of the model
*
*/
private String modelVersion;
/**
*
* The Amazon Resource Name (ARN) of the model.
*
*/
private String modelArn;
/**
*
* The unix timestamp for the date and time that the model was created.
*
*/
private java.util.Date creationTimestamp;
/**
*
* The description for the model.
*
*/
private String description;
/**
*
* The status of the model.
*
*/
private String status;
/**
*
* The status message for the model.
*
*/
private String statusMessage;
/**
*
* Performance metrics for the model. Created during training.
*
*/
private ModelPerformance performance;
/**
*
* The S3 location where Amazon Lookout for Vision saves model training files.
*
*/
private OutputConfig outputConfig;
/**
*
* 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.
*
*/
private OutputS3Object evaluationManifest;
/**
*
* The S3 location where Amazon Lookout for Vision saves the performance metrics.
*
*/
private OutputS3Object evaluationResult;
/**
*
* The unix timestamp for the date and time that the evaluation ended.
*
*/
private java.util.Date evaluationEndTimestamp;
/**
*
* The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during
* training.
*
*/
private String kmsKeyId;
/**
*
* The minimum number of inference units used by the model. For more information, see StartModel
*
*/
private Integer minInferenceUnits;
/**
*
* The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more
* information, see StartModel.
*
*/
private Integer maxInferenceUnits;
/**
*
* The version of the model
*
*
* @param modelVersion
* The version of the model
*/
public void setModelVersion(String modelVersion) {
this.modelVersion = modelVersion;
}
/**
*
* The version of the model
*
*
* @return The version of the model
*/
public String getModelVersion() {
return this.modelVersion;
}
/**
*
* The version of the model
*
*
* @param modelVersion
* The version of the model
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelDescription withModelVersion(String modelVersion) {
setModelVersion(modelVersion);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the model.
*
*
* @param modelArn
* The Amazon Resource Name (ARN) of the model.
*/
public void setModelArn(String modelArn) {
this.modelArn = modelArn;
}
/**
*
* The Amazon Resource Name (ARN) of the model.
*
*
* @return The Amazon Resource Name (ARN) of the model.
*/
public String getModelArn() {
return this.modelArn;
}
/**
*
* The Amazon Resource Name (ARN) of the model.
*
*
* @param modelArn
* The Amazon Resource Name (ARN) of the model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelDescription withModelArn(String modelArn) {
setModelArn(modelArn);
return this;
}
/**
*
* The unix timestamp for the date and time that the model was created.
*
*
* @param creationTimestamp
* The unix timestamp for the date and time that the model was created.
*/
public void setCreationTimestamp(java.util.Date creationTimestamp) {
this.creationTimestamp = creationTimestamp;
}
/**
*
* The unix timestamp for the date and time that the model was created.
*
*
* @return The unix timestamp for the date and time that the model was created.
*/
public java.util.Date getCreationTimestamp() {
return this.creationTimestamp;
}
/**
*
* The unix timestamp for the date and time that the model was created.
*
*
* @param creationTimestamp
* The unix timestamp for the date and time that the model was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelDescription withCreationTimestamp(java.util.Date creationTimestamp) {
setCreationTimestamp(creationTimestamp);
return this;
}
/**
*
* The description for the model.
*
*
* @param description
* The description for the model.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description for the model.
*
*
* @return The description for the model.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description for the model.
*
*
* @param description
* The description for the model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelDescription withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The status of the model.
*
*
* @param status
* The status of the model.
* @see ModelStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the model.
*
*
* @return The status of the model.
* @see ModelStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the model.
*
*
* @param status
* The status of the model.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ModelStatus
*/
public ModelDescription withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The status of the model.
*
*
* @param status
* The status of the model.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ModelStatus
*/
public ModelDescription withStatus(ModelStatus status) {
this.status = status.toString();
return this;
}
/**
*
* The status message for the model.
*
*
* @param statusMessage
* The status message for the model.
*/
public void setStatusMessage(String statusMessage) {
this.statusMessage = statusMessage;
}
/**
*
* The status message for the model.
*
*
* @return The status message for the model.
*/
public String getStatusMessage() {
return this.statusMessage;
}
/**
*
* The status message for the model.
*
*
* @param statusMessage
* The status message for the model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelDescription withStatusMessage(String statusMessage) {
setStatusMessage(statusMessage);
return this;
}
/**
*
* Performance metrics for the model. Created during training.
*
*
* @param performance
* Performance metrics for the model. Created during training.
*/
public void setPerformance(ModelPerformance performance) {
this.performance = performance;
}
/**
*
* Performance metrics for the model. Created during training.
*
*
* @return Performance metrics for the model. Created during training.
*/
public ModelPerformance getPerformance() {
return this.performance;
}
/**
*
* Performance metrics for the model. Created during training.
*
*
* @param performance
* Performance metrics for the model. Created during training.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelDescription withPerformance(ModelPerformance performance) {
setPerformance(performance);
return this;
}
/**
*
* The S3 location where Amazon Lookout for Vision saves model training files.
*
*
* @param outputConfig
* The S3 location where Amazon Lookout for Vision saves model training files.
*/
public void setOutputConfig(OutputConfig outputConfig) {
this.outputConfig = outputConfig;
}
/**
*
* The S3 location where Amazon Lookout for Vision saves model training files.
*
*
* @return The S3 location where Amazon Lookout for Vision saves model training files.
*/
public OutputConfig getOutputConfig() {
return this.outputConfig;
}
/**
*
* The S3 location where Amazon Lookout for Vision saves model training files.
*
*
* @param outputConfig
* The S3 location where Amazon Lookout for Vision saves model training files.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelDescription withOutputConfig(OutputConfig outputConfig) {
setOutputConfig(outputConfig);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setEvaluationManifest(OutputS3Object evaluationManifest) {
this.evaluationManifest = 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.
*
*
* @return 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.
*/
public OutputS3Object getEvaluationManifest() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelDescription withEvaluationManifest(OutputS3Object evaluationManifest) {
setEvaluationManifest(evaluationManifest);
return this;
}
/**
*
* The S3 location where Amazon Lookout for Vision saves the performance metrics.
*
*
* @param evaluationResult
* The S3 location where Amazon Lookout for Vision saves the performance metrics.
*/
public void setEvaluationResult(OutputS3Object evaluationResult) {
this.evaluationResult = evaluationResult;
}
/**
*
* The S3 location where Amazon Lookout for Vision saves the performance metrics.
*
*
* @return The S3 location where Amazon Lookout for Vision saves the performance metrics.
*/
public OutputS3Object getEvaluationResult() {
return this.evaluationResult;
}
/**
*
* The S3 location where Amazon Lookout for Vision saves the performance metrics.
*
*
* @param evaluationResult
* The S3 location where Amazon Lookout for Vision saves the performance metrics.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelDescription withEvaluationResult(OutputS3Object evaluationResult) {
setEvaluationResult(evaluationResult);
return this;
}
/**
*
* The unix timestamp for the date and time that the evaluation ended.
*
*
* @param evaluationEndTimestamp
* The unix timestamp for the date and time that the evaluation ended.
*/
public void setEvaluationEndTimestamp(java.util.Date evaluationEndTimestamp) {
this.evaluationEndTimestamp = evaluationEndTimestamp;
}
/**
*
* The unix timestamp for the date and time that the evaluation ended.
*
*
* @return The unix timestamp for the date and time that the evaluation ended.
*/
public java.util.Date getEvaluationEndTimestamp() {
return this.evaluationEndTimestamp;
}
/**
*
* The unix timestamp for the date and time that the evaluation ended.
*
*
* @param evaluationEndTimestamp
* The unix timestamp for the date and time that the evaluation ended.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelDescription withEvaluationEndTimestamp(java.util.Date evaluationEndTimestamp) {
setEvaluationEndTimestamp(evaluationEndTimestamp);
return this;
}
/**
*
* The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during
* training.
*
*
* @param kmsKeyId
* The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during
* training.
*/
public void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
}
/**
*
* The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during
* training.
*
*
* @return The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during
* training.
*/
public String getKmsKeyId() {
return this.kmsKeyId;
}
/**
*
* The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during
* training.
*
*
* @param kmsKeyId
* The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during
* training.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelDescription withKmsKeyId(String kmsKeyId) {
setKmsKeyId(kmsKeyId);
return this;
}
/**
*
* The minimum number of inference units used by the model. For more information, see StartModel
*
*
* @param minInferenceUnits
* The minimum number of inference units used by the model. For more information, see StartModel
*/
public void setMinInferenceUnits(Integer minInferenceUnits) {
this.minInferenceUnits = minInferenceUnits;
}
/**
*
* The minimum number of inference units used by the model. For more information, see StartModel
*
*
* @return The minimum number of inference units used by the model. For more information, see StartModel
*/
public Integer getMinInferenceUnits() {
return this.minInferenceUnits;
}
/**
*
* The minimum number of inference units used by the model. For more information, see StartModel
*
*
* @param minInferenceUnits
* The minimum number of inference units used by the model. For more information, see StartModel
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelDescription withMinInferenceUnits(Integer minInferenceUnits) {
setMinInferenceUnits(minInferenceUnits);
return this;
}
/**
*
* The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more
* information, see StartModel.
*
*
* @param maxInferenceUnits
* The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more
* information, see StartModel.
*/
public void setMaxInferenceUnits(Integer maxInferenceUnits) {
this.maxInferenceUnits = maxInferenceUnits;
}
/**
*
* The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more
* information, see StartModel.
*
*
* @return The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more
* information, see StartModel.
*/
public Integer getMaxInferenceUnits() {
return this.maxInferenceUnits;
}
/**
*
* The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more
* information, see StartModel.
*
*
* @param maxInferenceUnits
* The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more
* information, see StartModel.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelDescription withMaxInferenceUnits(Integer maxInferenceUnits) {
setMaxInferenceUnits(maxInferenceUnits);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getModelVersion() != null)
sb.append("ModelVersion: ").append(getModelVersion()).append(",");
if (getModelArn() != null)
sb.append("ModelArn: ").append(getModelArn()).append(",");
if (getCreationTimestamp() != null)
sb.append("CreationTimestamp: ").append(getCreationTimestamp()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getStatusMessage() != null)
sb.append("StatusMessage: ").append(getStatusMessage()).append(",");
if (getPerformance() != null)
sb.append("Performance: ").append(getPerformance()).append(",");
if (getOutputConfig() != null)
sb.append("OutputConfig: ").append(getOutputConfig()).append(",");
if (getEvaluationManifest() != null)
sb.append("EvaluationManifest: ").append(getEvaluationManifest()).append(",");
if (getEvaluationResult() != null)
sb.append("EvaluationResult: ").append(getEvaluationResult()).append(",");
if (getEvaluationEndTimestamp() != null)
sb.append("EvaluationEndTimestamp: ").append(getEvaluationEndTimestamp()).append(",");
if (getKmsKeyId() != null)
sb.append("KmsKeyId: ").append(getKmsKeyId()).append(",");
if (getMinInferenceUnits() != null)
sb.append("MinInferenceUnits: ").append(getMinInferenceUnits()).append(",");
if (getMaxInferenceUnits() != null)
sb.append("MaxInferenceUnits: ").append(getMaxInferenceUnits());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ModelDescription == false)
return false;
ModelDescription other = (ModelDescription) obj;
if (other.getModelVersion() == null ^ this.getModelVersion() == null)
return false;
if (other.getModelVersion() != null && other.getModelVersion().equals(this.getModelVersion()) == false)
return false;
if (other.getModelArn() == null ^ this.getModelArn() == null)
return false;
if (other.getModelArn() != null && other.getModelArn().equals(this.getModelArn()) == false)
return false;
if (other.getCreationTimestamp() == null ^ this.getCreationTimestamp() == null)
return false;
if (other.getCreationTimestamp() != null && other.getCreationTimestamp().equals(this.getCreationTimestamp()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getStatusMessage() == null ^ this.getStatusMessage() == null)
return false;
if (other.getStatusMessage() != null && other.getStatusMessage().equals(this.getStatusMessage()) == false)
return false;
if (other.getPerformance() == null ^ this.getPerformance() == null)
return false;
if (other.getPerformance() != null && other.getPerformance().equals(this.getPerformance()) == false)
return false;
if (other.getOutputConfig() == null ^ this.getOutputConfig() == null)
return false;
if (other.getOutputConfig() != null && other.getOutputConfig().equals(this.getOutputConfig()) == false)
return false;
if (other.getEvaluationManifest() == null ^ this.getEvaluationManifest() == null)
return false;
if (other.getEvaluationManifest() != null && other.getEvaluationManifest().equals(this.getEvaluationManifest()) == false)
return false;
if (other.getEvaluationResult() == null ^ this.getEvaluationResult() == null)
return false;
if (other.getEvaluationResult() != null && other.getEvaluationResult().equals(this.getEvaluationResult()) == false)
return false;
if (other.getEvaluationEndTimestamp() == null ^ this.getEvaluationEndTimestamp() == null)
return false;
if (other.getEvaluationEndTimestamp() != null && other.getEvaluationEndTimestamp().equals(this.getEvaluationEndTimestamp()) == false)
return false;
if (other.getKmsKeyId() == null ^ this.getKmsKeyId() == null)
return false;
if (other.getKmsKeyId() != null && other.getKmsKeyId().equals(this.getKmsKeyId()) == false)
return false;
if (other.getMinInferenceUnits() == null ^ this.getMinInferenceUnits() == null)
return false;
if (other.getMinInferenceUnits() != null && other.getMinInferenceUnits().equals(this.getMinInferenceUnits()) == false)
return false;
if (other.getMaxInferenceUnits() == null ^ this.getMaxInferenceUnits() == null)
return false;
if (other.getMaxInferenceUnits() != null && other.getMaxInferenceUnits().equals(this.getMaxInferenceUnits()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getModelVersion() == null) ? 0 : getModelVersion().hashCode());
hashCode = prime * hashCode + ((getModelArn() == null) ? 0 : getModelArn().hashCode());
hashCode = prime * hashCode + ((getCreationTimestamp() == null) ? 0 : getCreationTimestamp().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getStatusMessage() == null) ? 0 : getStatusMessage().hashCode());
hashCode = prime * hashCode + ((getPerformance() == null) ? 0 : getPerformance().hashCode());
hashCode = prime * hashCode + ((getOutputConfig() == null) ? 0 : getOutputConfig().hashCode());
hashCode = prime * hashCode + ((getEvaluationManifest() == null) ? 0 : getEvaluationManifest().hashCode());
hashCode = prime * hashCode + ((getEvaluationResult() == null) ? 0 : getEvaluationResult().hashCode());
hashCode = prime * hashCode + ((getEvaluationEndTimestamp() == null) ? 0 : getEvaluationEndTimestamp().hashCode());
hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode());
hashCode = prime * hashCode + ((getMinInferenceUnits() == null) ? 0 : getMinInferenceUnits().hashCode());
hashCode = prime * hashCode + ((getMaxInferenceUnits() == null) ? 0 : getMaxInferenceUnits().hashCode());
return hashCode;
}
@Override
public ModelDescription clone() {
try {
return (ModelDescription) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.lookoutforvision.model.transform.ModelDescriptionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}