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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-sagemaker Show documentation
The AWS Java SDK for Amazon SageMaker module holds the client classes that are used for communicating with Amazon SageMaker Service
The newest version!
/*
 * 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;

/**
 * 
 * Docker container image configuration object for the model explainability job.
 * 
 * 
 * @see AWS API Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ModelExplainabilityAppSpecification implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * The container image to be run by the model explainability job.
     * 
     */
    private String imageUri;
    /**
     * 
     * JSON formatted Amazon S3 file that defines explainability parameters. For more information on this JSON
     * configuration file, see Configure model explainability parameters.
     * 
     */
    private String configUri;
    /**
     * 
     * Sets the environment variables in the Docker container.
     * 
     */
    private java.util.Map environment;

    /**
     * 
     * The container image to be run by the model explainability job.
     * 
     * 
     * @param imageUri
     *        The container image to be run by the model explainability job.
     */

    public void setImageUri(String imageUri) {
        this.imageUri = imageUri;
    }

    /**
     * 
     * The container image to be run by the model explainability job.
     * 
     * 
     * @return The container image to be run by the model explainability job.
     */

    public String getImageUri() {
        return this.imageUri;
    }

    /**
     * 
     * The container image to be run by the model explainability job.
     * 
     * 
     * @param imageUri
     *        The container image to be run by the model explainability job.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ModelExplainabilityAppSpecification withImageUri(String imageUri) {
        setImageUri(imageUri);
        return this;
    }

    /**
     * 
     * JSON formatted Amazon S3 file that defines explainability parameters. For more information on this JSON
     * configuration file, see Configure model explainability parameters.
     * 
     * 
     * @param configUri
     *        JSON formatted Amazon S3 file that defines explainability parameters. For more information on this JSON
     *        configuration file, see Configure model explainability parameters.
     */

    public void setConfigUri(String configUri) {
        this.configUri = configUri;
    }

    /**
     * 
     * JSON formatted Amazon S3 file that defines explainability parameters. For more information on this JSON
     * configuration file, see Configure model explainability parameters.
     * 
     * 
     * @return JSON formatted Amazon S3 file that defines explainability parameters. For more information on this JSON
     *         configuration file, see Configure model explainability parameters.
     */

    public String getConfigUri() {
        return this.configUri;
    }

    /**
     * 
     * JSON formatted Amazon S3 file that defines explainability parameters. For more information on this JSON
     * configuration file, see Configure model explainability parameters.
     * 
     * 
     * @param configUri
     *        JSON formatted Amazon S3 file that defines explainability parameters. For more information on this JSON
     *        configuration file, see Configure model explainability parameters.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ModelExplainabilityAppSpecification withConfigUri(String configUri) {
        setConfigUri(configUri);
        return this;
    }

    /**
     * 
     * Sets the environment variables in the Docker container.
     * 
     * 
     * @return Sets the environment variables in the Docker container.
     */

    public java.util.Map getEnvironment() {
        return environment;
    }

    /**
     * 
     * Sets the environment variables in the Docker container.
     * 
     * 
     * @param environment
     *        Sets the environment variables in the Docker container.
     */

    public void setEnvironment(java.util.Map environment) {
        this.environment = environment;
    }

    /**
     * 
     * Sets the environment variables in the Docker container.
     * 
     * 
     * @param environment
     *        Sets the environment variables in the Docker container.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ModelExplainabilityAppSpecification withEnvironment(java.util.Map environment) {
        setEnvironment(environment);
        return this;
    }

    /**
     * Add a single Environment entry
     *
     * @see ModelExplainabilityAppSpecification#withEnvironment
     * @returns a reference to this object so that method calls can be chained together.
     */

    public ModelExplainabilityAppSpecification addEnvironmentEntry(String key, String value) {
        if (null == this.environment) {
            this.environment = new java.util.HashMap();
        }
        if (this.environment.containsKey(key))
            throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
        this.environment.put(key, value);
        return this;
    }

    /**
     * Removes all the entries added into Environment.
     *
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ModelExplainabilityAppSpecification clearEnvironmentEntries() {
        this.environment = null;
        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 (getImageUri() != null)
            sb.append("ImageUri: ").append(getImageUri()).append(",");
        if (getConfigUri() != null)
            sb.append("ConfigUri: ").append(getConfigUri()).append(",");
        if (getEnvironment() != null)
            sb.append("Environment: ").append(getEnvironment());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof ModelExplainabilityAppSpecification == false)
            return false;
        ModelExplainabilityAppSpecification other = (ModelExplainabilityAppSpecification) obj;
        if (other.getImageUri() == null ^ this.getImageUri() == null)
            return false;
        if (other.getImageUri() != null && other.getImageUri().equals(this.getImageUri()) == false)
            return false;
        if (other.getConfigUri() == null ^ this.getConfigUri() == null)
            return false;
        if (other.getConfigUri() != null && other.getConfigUri().equals(this.getConfigUri()) == false)
            return false;
        if (other.getEnvironment() == null ^ this.getEnvironment() == null)
            return false;
        if (other.getEnvironment() != null && other.getEnvironment().equals(this.getEnvironment()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getImageUri() == null) ? 0 : getImageUri().hashCode());
        hashCode = prime * hashCode + ((getConfigUri() == null) ? 0 : getConfigUri().hashCode());
        hashCode = prime * hashCode + ((getEnvironment() == null) ? 0 : getEnvironment().hashCode());
        return hashCode;
    }

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