com.amazonaws.services.sagemaker.model.CustomImage Maven / Gradle / Ivy

Go to download
/*
 * 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 custom SageMaker image. For more information, see Bring your own SageMaker image.
 * 
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CustomImage implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * The name of the CustomImage. Must be unique to your account.
     * 
     */
    private String imageName;
    /**
     * 
     * The version number of the CustomImage.
     * 
     */
    private Integer imageVersionNumber;
    /**
     * 
     * The name of the AppImageConfig.
     * 
     */
    private String appImageConfigName;

    /**
     * 
     * The name of the CustomImage. Must be unique to your account.
     * 
     * 
     * @param imageName
     *        The name of the CustomImage. Must be unique to your account.
     */

    public void setImageName(String imageName) {
        this.imageName = imageName;
    }

    /**
     * 
     * The name of the CustomImage. Must be unique to your account.
     * 
     * 
     * @return The name of the CustomImage. Must be unique to your account.
     */

    public String getImageName() {
        return this.imageName;
    }

    /**
     * 
     * The name of the CustomImage. Must be unique to your account.
     * 
     * 
     * @param imageName
     *        The name of the CustomImage. Must be unique to your account.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public CustomImage withImageName(String imageName) {
        setImageName(imageName);
        return this;
    }

    /**
     * 
     * The version number of the CustomImage.
     * 
     * 
     * @param imageVersionNumber
     *        The version number of the CustomImage.
     */

    public void setImageVersionNumber(Integer imageVersionNumber) {
        this.imageVersionNumber = imageVersionNumber;
    }

    /**
     * 
     * The version number of the CustomImage.
     * 
     * 
     * @return The version number of the CustomImage.
     */

    public Integer getImageVersionNumber() {
        return this.imageVersionNumber;
    }

    /**
     * 
     * The version number of the CustomImage.
     * 
     * 
     * @param imageVersionNumber
     *        The version number of the CustomImage.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public CustomImage withImageVersionNumber(Integer imageVersionNumber) {
        setImageVersionNumber(imageVersionNumber);
        return this;
    }

    /**
     * 
     * The name of the AppImageConfig.
     * 
     * 
     * @param appImageConfigName
     *        The name of the AppImageConfig.
     */

    public void setAppImageConfigName(String appImageConfigName) {
        this.appImageConfigName = appImageConfigName;
    }

    /**
     * 
     * The name of the AppImageConfig.
     * 
     * 
     * @return The name of the AppImageConfig.
     */

    public String getAppImageConfigName() {
        return this.appImageConfigName;
    }

    /**
     * 
     * The name of the AppImageConfig.
     * 
     * 
     * @param appImageConfigName
     *        The name of the AppImageConfig.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public CustomImage withAppImageConfigName(String appImageConfigName) {
        setAppImageConfigName(appImageConfigName);
        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 (getImageName() != null)
            sb.append("ImageName: ").append(getImageName()).append(",");
        if (getImageVersionNumber() != null)
            sb.append("ImageVersionNumber: ").append(getImageVersionNumber()).append(",");
        if (getAppImageConfigName() != null)
            sb.append("AppImageConfigName: ").append(getAppImageConfigName());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof CustomImage == false)
            return false;
        CustomImage other = (CustomImage) obj;
        if (other.getImageName() == null ^ this.getImageName() == null)
            return false;
        if (other.getImageName() != null && other.getImageName().equals(this.getImageName()) == false)
            return false;
        if (other.getImageVersionNumber() == null ^ this.getImageVersionNumber() == null)
            return false;
        if (other.getImageVersionNumber() != null && other.getImageVersionNumber().equals(this.getImageVersionNumber()) == false)
            return false;
        if (other.getAppImageConfigName() == null ^ this.getAppImageConfigName() == null)
            return false;
        if (other.getAppImageConfigName() != null && other.getAppImageConfigName().equals(this.getAppImageConfigName()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getImageName() == null) ? 0 : getImageName().hashCode());
        hashCode = prime * hashCode + ((getImageVersionNumber() == null) ? 0 : getImageVersionNumber().hashCode());
        hashCode = prime * hashCode + ((getAppImageConfigName() == null) ? 0 : getAppImageConfigName().hashCode());
        return hashCode;
    }

    @Override
    public CustomImage clone() {
        try {
            return (CustomImage) 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.CustomImageMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}