com.amazonaws.services.sagemaker.model.ModelCard Maven / Gradle / Ivy
/*
* Copyright 2019-2024 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.sagemaker.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* An Amazon SageMaker Model Card.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ModelCard implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon Resource Name (ARN) of the model card.
*
*/
private String modelCardArn;
/**
*
* The unique name of the model card.
*
*/
private String modelCardName;
/**
*
* The version of the model card.
*
*/
private Integer modelCardVersion;
/**
*
* The content of the model card. Content uses the model card JSON
* schema and provided as a string.
*
*/
private String content;
/**
*
* The approval status of the model card within your organization. Different organizations might have different
* criteria for model card review and approval.
*
*
* -
*
* Draft: The model card is a work in progress.
*
*
* -
*
* PendingReview: The model card is pending review.
*
*
* -
*
* Approved: The model card is approved.
*
*
* -
*
* Archived: The model card is archived. No more updates should be made to the model card, but it can
* still be exported.
*
*
*
*/
private String modelCardStatus;
/**
*
* The security configuration used to protect model card data.
*
*/
private ModelCardSecurityConfig securityConfig;
/**
*
* The date and time that the model card was created.
*
*/
private java.util.Date creationTime;
private UserContext createdBy;
/**
*
* The date and time that the model card was last modified.
*
*/
private java.util.Date lastModifiedTime;
private UserContext lastModifiedBy;
/**
*
* Key-value pairs used to manage metadata for the model card.
*
*/
private java.util.List tags;
/**
*
* The unique name (ID) of the model.
*
*/
private String modelId;
/**
*
* The risk rating of the model. Different organizations might have different criteria for model card risk ratings.
* For more information, see Risk ratings.
*
*/
private String riskRating;
/**
*
* The model package group that contains the model package. Only relevant for model cards created for model packages
* in the Amazon SageMaker Model Registry.
*
*/
private String modelPackageGroupName;
/**
*
* The Amazon Resource Name (ARN) of the model card.
*
*
* @param modelCardArn
* The Amazon Resource Name (ARN) of the model card.
*/
public void setModelCardArn(String modelCardArn) {
this.modelCardArn = modelCardArn;
}
/**
*
* The Amazon Resource Name (ARN) of the model card.
*
*
* @return The Amazon Resource Name (ARN) of the model card.
*/
public String getModelCardArn() {
return this.modelCardArn;
}
/**
*
* The Amazon Resource Name (ARN) of the model card.
*
*
* @param modelCardArn
* The Amazon Resource Name (ARN) of the model card.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelCard withModelCardArn(String modelCardArn) {
setModelCardArn(modelCardArn);
return this;
}
/**
*
* The unique name of the model card.
*
*
* @param modelCardName
* The unique name of the model card.
*/
public void setModelCardName(String modelCardName) {
this.modelCardName = modelCardName;
}
/**
*
* The unique name of the model card.
*
*
* @return The unique name of the model card.
*/
public String getModelCardName() {
return this.modelCardName;
}
/**
*
* The unique name of the model card.
*
*
* @param modelCardName
* The unique name of the model card.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelCard withModelCardName(String modelCardName) {
setModelCardName(modelCardName);
return this;
}
/**
*
* The version of the model card.
*
*
* @param modelCardVersion
* The version of the model card.
*/
public void setModelCardVersion(Integer modelCardVersion) {
this.modelCardVersion = modelCardVersion;
}
/**
*
* The version of the model card.
*
*
* @return The version of the model card.
*/
public Integer getModelCardVersion() {
return this.modelCardVersion;
}
/**
*
* The version of the model card.
*
*
* @param modelCardVersion
* The version of the model card.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelCard withModelCardVersion(Integer modelCardVersion) {
setModelCardVersion(modelCardVersion);
return this;
}
/**
*
* The content of the model card. Content uses the model card JSON
* schema and provided as a string.
*
*
* @param content
* The content of the model card. Content uses the model card
* JSON schema and provided as a string.
*/
public void setContent(String content) {
this.content = content;
}
/**
*
* The content of the model card. Content uses the model card JSON
* schema and provided as a string.
*
*
* @return The content of the model card. Content uses the model
* card JSON schema and provided as a string.
*/
public String getContent() {
return this.content;
}
/**
*
* The content of the model card. Content uses the model card JSON
* schema and provided as a string.
*
*
* @param content
* The content of the model card. Content uses the model card
* JSON schema and provided as a string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelCard withContent(String content) {
setContent(content);
return this;
}
/**
*
* The approval status of the model card within your organization. Different organizations might have different
* criteria for model card review and approval.
*
*
* -
*
* Draft: The model card is a work in progress.
*
*
* -
*
* PendingReview: The model card is pending review.
*
*
* -
*
* Approved: The model card is approved.
*
*
* -
*
* Archived: The model card is archived. No more updates should be made to the model card, but it can
* still be exported.
*
*
*
*
* @param modelCardStatus
* The approval status of the model card within your organization. Different organizations might have
* different criteria for model card review and approval.
*
* -
*
* Draft: The model card is a work in progress.
*
*
* -
*
* PendingReview: The model card is pending review.
*
*
* -
*
* Approved: The model card is approved.
*
*
* -
*
* Archived: The model card is archived. No more updates should be made to the model card, but
* it can still be exported.
*
*
* @see ModelCardStatus
*/
public void setModelCardStatus(String modelCardStatus) {
this.modelCardStatus = modelCardStatus;
}
/**
*
* The approval status of the model card within your organization. Different organizations might have different
* criteria for model card review and approval.
*
*
* -
*
* Draft: The model card is a work in progress.
*
*
* -
*
* PendingReview: The model card is pending review.
*
*
* -
*
* Approved: The model card is approved.
*
*
* -
*
* Archived: The model card is archived. No more updates should be made to the model card, but it can
* still be exported.
*
*
*
*
* @return The approval status of the model card within your organization. Different organizations might have
* different criteria for model card review and approval.
*
* -
*
* Draft: The model card is a work in progress.
*
*
* -
*
* PendingReview: The model card is pending review.
*
*
* -
*
* Approved: The model card is approved.
*
*
* -
*
* Archived: The model card is archived. No more updates should be made to the model card, but
* it can still be exported.
*
*
* @see ModelCardStatus
*/
public String getModelCardStatus() {
return this.modelCardStatus;
}
/**
*
* The approval status of the model card within your organization. Different organizations might have different
* criteria for model card review and approval.
*
*
* -
*
* Draft: The model card is a work in progress.
*
*
* -
*
* PendingReview: The model card is pending review.
*
*
* -
*
* Approved: The model card is approved.
*
*
* -
*
* Archived: The model card is archived. No more updates should be made to the model card, but it can
* still be exported.
*
*
*
*
* @param modelCardStatus
* The approval status of the model card within your organization. Different organizations might have
* different criteria for model card review and approval.
*
* -
*
* Draft: The model card is a work in progress.
*
*
* -
*
* PendingReview: The model card is pending review.
*
*
* -
*
* Approved: The model card is approved.
*
*
* -
*
* Archived: The model card is archived. No more updates should be made to the model card, but
* it can still be exported.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ModelCardStatus
*/
public ModelCard withModelCardStatus(String modelCardStatus) {
setModelCardStatus(modelCardStatus);
return this;
}
/**
*
* The approval status of the model card within your organization. Different organizations might have different
* criteria for model card review and approval.
*
*
* -
*
* Draft: The model card is a work in progress.
*
*
* -
*
* PendingReview: The model card is pending review.
*
*
* -
*
* Approved: The model card is approved.
*
*
* -
*
* Archived: The model card is archived. No more updates should be made to the model card, but it can
* still be exported.
*
*
*
*
* @param modelCardStatus
* The approval status of the model card within your organization. Different organizations might have
* different criteria for model card review and approval.
*
* -
*
* Draft: The model card is a work in progress.
*
*
* -
*
* PendingReview: The model card is pending review.
*
*
* -
*
* Approved: The model card is approved.
*
*
* -
*
* Archived: The model card is archived. No more updates should be made to the model card, but
* it can still be exported.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ModelCardStatus
*/
public ModelCard withModelCardStatus(ModelCardStatus modelCardStatus) {
this.modelCardStatus = modelCardStatus.toString();
return this;
}
/**
*
* The security configuration used to protect model card data.
*
*
* @param securityConfig
* The security configuration used to protect model card data.
*/
public void setSecurityConfig(ModelCardSecurityConfig securityConfig) {
this.securityConfig = securityConfig;
}
/**
*
* The security configuration used to protect model card data.
*
*
* @return The security configuration used to protect model card data.
*/
public ModelCardSecurityConfig getSecurityConfig() {
return this.securityConfig;
}
/**
*
* The security configuration used to protect model card data.
*
*
* @param securityConfig
* The security configuration used to protect model card data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelCard withSecurityConfig(ModelCardSecurityConfig securityConfig) {
setSecurityConfig(securityConfig);
return this;
}
/**
*
* The date and time that the model card was created.
*
*
* @param creationTime
* The date and time that the model card was created.
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* The date and time that the model card was created.
*
*
* @return The date and time that the model card was created.
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* The date and time that the model card was created.
*
*
* @param creationTime
* The date and time that the model card was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelCard withCreationTime(java.util.Date creationTime) {
setCreationTime(creationTime);
return this;
}
/**
* @param createdBy
*/
public void setCreatedBy(UserContext createdBy) {
this.createdBy = createdBy;
}
/**
* @return
*/
public UserContext getCreatedBy() {
return this.createdBy;
}
/**
* @param createdBy
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelCard withCreatedBy(UserContext createdBy) {
setCreatedBy(createdBy);
return this;
}
/**
*
* The date and time that the model card was last modified.
*
*
* @param lastModifiedTime
* The date and time that the model card was last modified.
*/
public void setLastModifiedTime(java.util.Date lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
}
/**
*
* The date and time that the model card was last modified.
*
*
* @return The date and time that the model card was last modified.
*/
public java.util.Date getLastModifiedTime() {
return this.lastModifiedTime;
}
/**
*
* The date and time that the model card was last modified.
*
*
* @param lastModifiedTime
* The date and time that the model card was last modified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelCard withLastModifiedTime(java.util.Date lastModifiedTime) {
setLastModifiedTime(lastModifiedTime);
return this;
}
/**
* @param lastModifiedBy
*/
public void setLastModifiedBy(UserContext lastModifiedBy) {
this.lastModifiedBy = lastModifiedBy;
}
/**
* @return
*/
public UserContext getLastModifiedBy() {
return this.lastModifiedBy;
}
/**
* @param lastModifiedBy
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelCard withLastModifiedBy(UserContext lastModifiedBy) {
setLastModifiedBy(lastModifiedBy);
return this;
}
/**
*
* Key-value pairs used to manage metadata for the model card.
*
*
* @return Key-value pairs used to manage metadata for the model card.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* Key-value pairs used to manage metadata for the model card.
*
*
* @param tags
* Key-value pairs used to manage metadata for the model card.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* Key-value pairs used to manage metadata for the model card.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* Key-value pairs used to manage metadata for the model card.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelCard withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* Key-value pairs used to manage metadata for the model card.
*
*
* @param tags
* Key-value pairs used to manage metadata for the model card.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelCard withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* The unique name (ID) of the model.
*
*
* @param modelId
* The unique name (ID) of the model.
*/
public void setModelId(String modelId) {
this.modelId = modelId;
}
/**
*
* The unique name (ID) of the model.
*
*
* @return The unique name (ID) of the model.
*/
public String getModelId() {
return this.modelId;
}
/**
*
* The unique name (ID) of the model.
*
*
* @param modelId
* The unique name (ID) of the model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelCard withModelId(String modelId) {
setModelId(modelId);
return this;
}
/**
*
* The risk rating of the model. Different organizations might have different criteria for model card risk ratings.
* For more information, see Risk ratings.
*
*
* @param riskRating
* The risk rating of the model. Different organizations might have different criteria for model card risk
* ratings. For more information, see Risk ratings.
*/
public void setRiskRating(String riskRating) {
this.riskRating = riskRating;
}
/**
*
* The risk rating of the model. Different organizations might have different criteria for model card risk ratings.
* For more information, see Risk ratings.
*
*
* @return The risk rating of the model. Different organizations might have different criteria for model card risk
* ratings. For more information, see Risk ratings.
*/
public String getRiskRating() {
return this.riskRating;
}
/**
*
* The risk rating of the model. Different organizations might have different criteria for model card risk ratings.
* For more information, see Risk ratings.
*
*
* @param riskRating
* The risk rating of the model. Different organizations might have different criteria for model card risk
* ratings. For more information, see Risk ratings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelCard withRiskRating(String riskRating) {
setRiskRating(riskRating);
return this;
}
/**
*
* The model package group that contains the model package. Only relevant for model cards created for model packages
* in the Amazon SageMaker Model Registry.
*
*
* @param modelPackageGroupName
* The model package group that contains the model package. Only relevant for model cards created for model
* packages in the Amazon SageMaker Model Registry.
*/
public void setModelPackageGroupName(String modelPackageGroupName) {
this.modelPackageGroupName = modelPackageGroupName;
}
/**
*
* The model package group that contains the model package. Only relevant for model cards created for model packages
* in the Amazon SageMaker Model Registry.
*
*
* @return The model package group that contains the model package. Only relevant for model cards created for model
* packages in the Amazon SageMaker Model Registry.
*/
public String getModelPackageGroupName() {
return this.modelPackageGroupName;
}
/**
*
* The model package group that contains the model package. Only relevant for model cards created for model packages
* in the Amazon SageMaker Model Registry.
*
*
* @param modelPackageGroupName
* The model package group that contains the model package. Only relevant for model cards created for model
* packages in the Amazon SageMaker Model Registry.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelCard withModelPackageGroupName(String modelPackageGroupName) {
setModelPackageGroupName(modelPackageGroupName);
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 (getModelCardArn() != null)
sb.append("ModelCardArn: ").append(getModelCardArn()).append(",");
if (getModelCardName() != null)
sb.append("ModelCardName: ").append(getModelCardName()).append(",");
if (getModelCardVersion() != null)
sb.append("ModelCardVersion: ").append(getModelCardVersion()).append(",");
if (getContent() != null)
sb.append("Content: ").append("***Sensitive Data Redacted***").append(",");
if (getModelCardStatus() != null)
sb.append("ModelCardStatus: ").append(getModelCardStatus()).append(",");
if (getSecurityConfig() != null)
sb.append("SecurityConfig: ").append(getSecurityConfig()).append(",");
if (getCreationTime() != null)
sb.append("CreationTime: ").append(getCreationTime()).append(",");
if (getCreatedBy() != null)
sb.append("CreatedBy: ").append(getCreatedBy()).append(",");
if (getLastModifiedTime() != null)
sb.append("LastModifiedTime: ").append(getLastModifiedTime()).append(",");
if (getLastModifiedBy() != null)
sb.append("LastModifiedBy: ").append(getLastModifiedBy()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getModelId() != null)
sb.append("ModelId: ").append(getModelId()).append(",");
if (getRiskRating() != null)
sb.append("RiskRating: ").append(getRiskRating()).append(",");
if (getModelPackageGroupName() != null)
sb.append("ModelPackageGroupName: ").append(getModelPackageGroupName());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ModelCard == false)
return false;
ModelCard other = (ModelCard) obj;
if (other.getModelCardArn() == null ^ this.getModelCardArn() == null)
return false;
if (other.getModelCardArn() != null && other.getModelCardArn().equals(this.getModelCardArn()) == false)
return false;
if (other.getModelCardName() == null ^ this.getModelCardName() == null)
return false;
if (other.getModelCardName() != null && other.getModelCardName().equals(this.getModelCardName()) == false)
return false;
if (other.getModelCardVersion() == null ^ this.getModelCardVersion() == null)
return false;
if (other.getModelCardVersion() != null && other.getModelCardVersion().equals(this.getModelCardVersion()) == false)
return false;
if (other.getContent() == null ^ this.getContent() == null)
return false;
if (other.getContent() != null && other.getContent().equals(this.getContent()) == false)
return false;
if (other.getModelCardStatus() == null ^ this.getModelCardStatus() == null)
return false;
if (other.getModelCardStatus() != null && other.getModelCardStatus().equals(this.getModelCardStatus()) == false)
return false;
if (other.getSecurityConfig() == null ^ this.getSecurityConfig() == null)
return false;
if (other.getSecurityConfig() != null && other.getSecurityConfig().equals(this.getSecurityConfig()) == false)
return false;
if (other.getCreationTime() == null ^ this.getCreationTime() == null)
return false;
if (other.getCreationTime() != null && other.getCreationTime().equals(this.getCreationTime()) == false)
return false;
if (other.getCreatedBy() == null ^ this.getCreatedBy() == null)
return false;
if (other.getCreatedBy() != null && other.getCreatedBy().equals(this.getCreatedBy()) == false)
return false;
if (other.getLastModifiedTime() == null ^ this.getLastModifiedTime() == null)
return false;
if (other.getLastModifiedTime() != null && other.getLastModifiedTime().equals(this.getLastModifiedTime()) == false)
return false;
if (other.getLastModifiedBy() == null ^ this.getLastModifiedBy() == null)
return false;
if (other.getLastModifiedBy() != null && other.getLastModifiedBy().equals(this.getLastModifiedBy()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getModelId() == null ^ this.getModelId() == null)
return false;
if (other.getModelId() != null && other.getModelId().equals(this.getModelId()) == false)
return false;
if (other.getRiskRating() == null ^ this.getRiskRating() == null)
return false;
if (other.getRiskRating() != null && other.getRiskRating().equals(this.getRiskRating()) == false)
return false;
if (other.getModelPackageGroupName() == null ^ this.getModelPackageGroupName() == null)
return false;
if (other.getModelPackageGroupName() != null && other.getModelPackageGroupName().equals(this.getModelPackageGroupName()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getModelCardArn() == null) ? 0 : getModelCardArn().hashCode());
hashCode = prime * hashCode + ((getModelCardName() == null) ? 0 : getModelCardName().hashCode());
hashCode = prime * hashCode + ((getModelCardVersion() == null) ? 0 : getModelCardVersion().hashCode());
hashCode = prime * hashCode + ((getContent() == null) ? 0 : getContent().hashCode());
hashCode = prime * hashCode + ((getModelCardStatus() == null) ? 0 : getModelCardStatus().hashCode());
hashCode = prime * hashCode + ((getSecurityConfig() == null) ? 0 : getSecurityConfig().hashCode());
hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode());
hashCode = prime * hashCode + ((getCreatedBy() == null) ? 0 : getCreatedBy().hashCode());
hashCode = prime * hashCode + ((getLastModifiedTime() == null) ? 0 : getLastModifiedTime().hashCode());
hashCode = prime * hashCode + ((getLastModifiedBy() == null) ? 0 : getLastModifiedBy().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getModelId() == null) ? 0 : getModelId().hashCode());
hashCode = prime * hashCode + ((getRiskRating() == null) ? 0 : getRiskRating().hashCode());
hashCode = prime * hashCode + ((getModelPackageGroupName() == null) ? 0 : getModelPackageGroupName().hashCode());
return hashCode;
}
@Override
public ModelCard clone() {
try {
return (ModelCard) 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.sagemaker.model.transform.ModelCardMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}