com.amazonaws.services.sagemaker.model.ModelPackageGroup Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sagemaker Show documentation
/*
* 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;
/**
*
* A group of versioned models in the model registry.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ModelPackageGroup implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the model group.
*
*/
private String modelPackageGroupName;
/**
*
* The Amazon Resource Name (ARN) of the model group.
*
*/
private String modelPackageGroupArn;
/**
*
* The description for the model group.
*
*/
private String modelPackageGroupDescription;
/**
*
* The time that the model group was created.
*
*/
private java.util.Date creationTime;
private UserContext createdBy;
/**
*
* The status of the model group. This can be one of the following values.
*
*
* -
*
* PENDING - The model group is pending being created.
*
*
* -
*
* IN_PROGRESS - The model group is in the process of being created.
*
*
* -
*
* COMPLETED - The model group was successfully created.
*
*
* -
*
* FAILED - The model group failed.
*
*
* -
*
* DELETING - The model group is in the process of being deleted.
*
*
* -
*
* DELETE_FAILED - SageMaker failed to delete the model group.
*
*
*
*/
private String modelPackageGroupStatus;
/**
*
* A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services resources
* in the Amazon Web Services General Reference Guide.
*
*/
private java.util.List tags;
/**
*
* The name of the model group.
*
*
* @param modelPackageGroupName
* The name of the model group.
*/
public void setModelPackageGroupName(String modelPackageGroupName) {
this.modelPackageGroupName = modelPackageGroupName;
}
/**
*
* The name of the model group.
*
*
* @return The name of the model group.
*/
public String getModelPackageGroupName() {
return this.modelPackageGroupName;
}
/**
*
* The name of the model group.
*
*
* @param modelPackageGroupName
* The name of the model group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelPackageGroup withModelPackageGroupName(String modelPackageGroupName) {
setModelPackageGroupName(modelPackageGroupName);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the model group.
*
*
* @param modelPackageGroupArn
* The Amazon Resource Name (ARN) of the model group.
*/
public void setModelPackageGroupArn(String modelPackageGroupArn) {
this.modelPackageGroupArn = modelPackageGroupArn;
}
/**
*
* The Amazon Resource Name (ARN) of the model group.
*
*
* @return The Amazon Resource Name (ARN) of the model group.
*/
public String getModelPackageGroupArn() {
return this.modelPackageGroupArn;
}
/**
*
* The Amazon Resource Name (ARN) of the model group.
*
*
* @param modelPackageGroupArn
* The Amazon Resource Name (ARN) of the model group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelPackageGroup withModelPackageGroupArn(String modelPackageGroupArn) {
setModelPackageGroupArn(modelPackageGroupArn);
return this;
}
/**
*
* The description for the model group.
*
*
* @param modelPackageGroupDescription
* The description for the model group.
*/
public void setModelPackageGroupDescription(String modelPackageGroupDescription) {
this.modelPackageGroupDescription = modelPackageGroupDescription;
}
/**
*
* The description for the model group.
*
*
* @return The description for the model group.
*/
public String getModelPackageGroupDescription() {
return this.modelPackageGroupDescription;
}
/**
*
* The description for the model group.
*
*
* @param modelPackageGroupDescription
* The description for the model group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelPackageGroup withModelPackageGroupDescription(String modelPackageGroupDescription) {
setModelPackageGroupDescription(modelPackageGroupDescription);
return this;
}
/**
*
* The time that the model group was created.
*
*
* @param creationTime
* The time that the model group was created.
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* The time that the model group was created.
*
*
* @return The time that the model group was created.
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* The time that the model group was created.
*
*
* @param creationTime
* The time that the model group was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelPackageGroup 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 ModelPackageGroup withCreatedBy(UserContext createdBy) {
setCreatedBy(createdBy);
return this;
}
/**
*
* The status of the model group. This can be one of the following values.
*
*
* -
*
* PENDING - The model group is pending being created.
*
*
* -
*
* IN_PROGRESS - The model group is in the process of being created.
*
*
* -
*
* COMPLETED - The model group was successfully created.
*
*
* -
*
* FAILED - The model group failed.
*
*
* -
*
* DELETING - The model group is in the process of being deleted.
*
*
* -
*
* DELETE_FAILED - SageMaker failed to delete the model group.
*
*
*
*
* @param modelPackageGroupStatus
* The status of the model group. This can be one of the following values.
*
* -
*
* PENDING - The model group is pending being created.
*
*
* -
*
* IN_PROGRESS - The model group is in the process of being created.
*
*
* -
*
* COMPLETED - The model group was successfully created.
*
*
* -
*
* FAILED - The model group failed.
*
*
* -
*
* DELETING - The model group is in the process of being deleted.
*
*
* -
*
* DELETE_FAILED - SageMaker failed to delete the model group.
*
*
* @see ModelPackageGroupStatus
*/
public void setModelPackageGroupStatus(String modelPackageGroupStatus) {
this.modelPackageGroupStatus = modelPackageGroupStatus;
}
/**
*
* The status of the model group. This can be one of the following values.
*
*
* -
*
* PENDING - The model group is pending being created.
*
*
* -
*
* IN_PROGRESS - The model group is in the process of being created.
*
*
* -
*
* COMPLETED - The model group was successfully created.
*
*
* -
*
* FAILED - The model group failed.
*
*
* -
*
* DELETING - The model group is in the process of being deleted.
*
*
* -
*
* DELETE_FAILED - SageMaker failed to delete the model group.
*
*
*
*
* @return The status of the model group. This can be one of the following values.
*
* -
*
* PENDING - The model group is pending being created.
*
*
* -
*
* IN_PROGRESS - The model group is in the process of being created.
*
*
* -
*
* COMPLETED - The model group was successfully created.
*
*
* -
*
* FAILED - The model group failed.
*
*
* -
*
* DELETING - The model group is in the process of being deleted.
*
*
* -
*
* DELETE_FAILED - SageMaker failed to delete the model group.
*
*
* @see ModelPackageGroupStatus
*/
public String getModelPackageGroupStatus() {
return this.modelPackageGroupStatus;
}
/**
*
* The status of the model group. This can be one of the following values.
*
*
* -
*
* PENDING - The model group is pending being created.
*
*
* -
*
* IN_PROGRESS - The model group is in the process of being created.
*
*
* -
*
* COMPLETED - The model group was successfully created.
*
*
* -
*
* FAILED - The model group failed.
*
*
* -
*
* DELETING - The model group is in the process of being deleted.
*
*
* -
*
* DELETE_FAILED - SageMaker failed to delete the model group.
*
*
*
*
* @param modelPackageGroupStatus
* The status of the model group. This can be one of the following values.
*
* -
*
* PENDING - The model group is pending being created.
*
*
* -
*
* IN_PROGRESS - The model group is in the process of being created.
*
*
* -
*
* COMPLETED - The model group was successfully created.
*
*
* -
*
* FAILED - The model group failed.
*
*
* -
*
* DELETING - The model group is in the process of being deleted.
*
*
* -
*
* DELETE_FAILED - SageMaker failed to delete the model group.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ModelPackageGroupStatus
*/
public ModelPackageGroup withModelPackageGroupStatus(String modelPackageGroupStatus) {
setModelPackageGroupStatus(modelPackageGroupStatus);
return this;
}
/**
*
* The status of the model group. This can be one of the following values.
*
*
* -
*
* PENDING - The model group is pending being created.
*
*
* -
*
* IN_PROGRESS - The model group is in the process of being created.
*
*
* -
*
* COMPLETED - The model group was successfully created.
*
*
* -
*
* FAILED - The model group failed.
*
*
* -
*
* DELETING - The model group is in the process of being deleted.
*
*
* -
*
* DELETE_FAILED - SageMaker failed to delete the model group.
*
*
*
*
* @param modelPackageGroupStatus
* The status of the model group. This can be one of the following values.
*
* -
*
* PENDING - The model group is pending being created.
*
*
* -
*
* IN_PROGRESS - The model group is in the process of being created.
*
*
* -
*
* COMPLETED - The model group was successfully created.
*
*
* -
*
* FAILED - The model group failed.
*
*
* -
*
* DELETING - The model group is in the process of being deleted.
*
*
* -
*
* DELETE_FAILED - SageMaker failed to delete the model group.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ModelPackageGroupStatus
*/
public ModelPackageGroup withModelPackageGroupStatus(ModelPackageGroupStatus modelPackageGroupStatus) {
this.modelPackageGroupStatus = modelPackageGroupStatus.toString();
return this;
}
/**
*
* A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services resources
* in the Amazon Web Services General Reference Guide.
*
*
* @return A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services
* resources in the Amazon Web Services General Reference Guide.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services resources
* in the Amazon Web Services General Reference Guide.
*
*
* @param tags
* A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services
* resources in the Amazon Web Services General Reference Guide.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services resources
* in the Amazon Web Services General Reference Guide.
*
*
* 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
* A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services
* resources in the Amazon Web Services General Reference Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelPackageGroup withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services resources
* in the Amazon Web Services General Reference Guide.
*
*
* @param tags
* A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services
* resources in the Amazon Web Services General Reference Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModelPackageGroup withTags(java.util.Collection tags) {
setTags(tags);
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 (getModelPackageGroupName() != null)
sb.append("ModelPackageGroupName: ").append(getModelPackageGroupName()).append(",");
if (getModelPackageGroupArn() != null)
sb.append("ModelPackageGroupArn: ").append(getModelPackageGroupArn()).append(",");
if (getModelPackageGroupDescription() != null)
sb.append("ModelPackageGroupDescription: ").append(getModelPackageGroupDescription()).append(",");
if (getCreationTime() != null)
sb.append("CreationTime: ").append(getCreationTime()).append(",");
if (getCreatedBy() != null)
sb.append("CreatedBy: ").append(getCreatedBy()).append(",");
if (getModelPackageGroupStatus() != null)
sb.append("ModelPackageGroupStatus: ").append(getModelPackageGroupStatus()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ModelPackageGroup == false)
return false;
ModelPackageGroup other = (ModelPackageGroup) obj;
if (other.getModelPackageGroupName() == null ^ this.getModelPackageGroupName() == null)
return false;
if (other.getModelPackageGroupName() != null && other.getModelPackageGroupName().equals(this.getModelPackageGroupName()) == false)
return false;
if (other.getModelPackageGroupArn() == null ^ this.getModelPackageGroupArn() == null)
return false;
if (other.getModelPackageGroupArn() != null && other.getModelPackageGroupArn().equals(this.getModelPackageGroupArn()) == false)
return false;
if (other.getModelPackageGroupDescription() == null ^ this.getModelPackageGroupDescription() == null)
return false;
if (other.getModelPackageGroupDescription() != null && other.getModelPackageGroupDescription().equals(this.getModelPackageGroupDescription()) == 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.getModelPackageGroupStatus() == null ^ this.getModelPackageGroupStatus() == null)
return false;
if (other.getModelPackageGroupStatus() != null && other.getModelPackageGroupStatus().equals(this.getModelPackageGroupStatus()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getModelPackageGroupName() == null) ? 0 : getModelPackageGroupName().hashCode());
hashCode = prime * hashCode + ((getModelPackageGroupArn() == null) ? 0 : getModelPackageGroupArn().hashCode());
hashCode = prime * hashCode + ((getModelPackageGroupDescription() == null) ? 0 : getModelPackageGroupDescription().hashCode());
hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode());
hashCode = prime * hashCode + ((getCreatedBy() == null) ? 0 : getCreatedBy().hashCode());
hashCode = prime * hashCode + ((getModelPackageGroupStatus() == null) ? 0 : getModelPackageGroupStatus().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public ModelPackageGroup clone() {
try {
return (ModelPackageGroup) 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.ModelPackageGroupMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}