com.amazonaws.services.codedeploy.model.Diagnostics Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
 * Copyright 2010-2016 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.codedeploy.model;
import java.io.Serializable;
/**
 * 
 * Diagnostic information about executable scripts that are part of a
 * deployment.
 * 
 */
public class Diagnostics implements Serializable, Cloneable {
    /**
     * 
     * The associated error code:
     * 
     * 
     * - Success: The specified script ran.
 
     * - ScriptMissing: The specified script was not found in the specified
     * location.
 
     * - ScriptNotExecutable: The specified script is not a recognized
     * executable file type.
 
     * - ScriptTimedOut: The specified script did not finish running in the
     * specified time period.
 
     * - ScriptFailed: The specified script failed to run as expected.
 
     * - UnknownError: The specified script did not run for an unknown reason.
     * 
 
     * 
     */
    private String errorCode;
    /**
     * 
     * The name of the script.
     * 
     */
    private String scriptName;
    /**
     * 
     * The message associated with the error.
     * 
     */
    private String message;
    /**
     * 
     * The last portion of the diagnostic log.
     * 
     * 
     * If available, AWS CodeDeploy returns up to the last 4 KB of the
     * diagnostic log.
     * 
     */
    private String logTail;
    /**
     * 
     * The associated error code:
     * 
     * 
     * - Success: The specified script ran.
 
     * - ScriptMissing: The specified script was not found in the specified
     * location.
 
     * - ScriptNotExecutable: The specified script is not a recognized
     * executable file type.
 
     * - ScriptTimedOut: The specified script did not finish running in the
     * specified time period.
 
     * - ScriptFailed: The specified script failed to run as expected.
 
     * - UnknownError: The specified script did not run for an unknown reason.
     * 
 
     * 
     * 
     * @param errorCode
     *        The associated error code:
     *        
     *        - Success: The specified script ran.
 
     *        - ScriptMissing: The specified script was not found in the
     *        specified location.
 
     *        - ScriptNotExecutable: The specified script is not a recognized
     *        executable file type.
 
     *        - ScriptTimedOut: The specified script did not finish running in
     *        the specified time period.
 
     *        - ScriptFailed: The specified script failed to run as expected.
 
     *        - UnknownError: The specified script did not run for an unknown
     *        reason.
 
     * @see LifecycleErrorCode
     */
    public void setErrorCode(String errorCode) {
        this.errorCode = errorCode;
    }
    /**
     * 
     * The associated error code:
     * 
     * 
     * - Success: The specified script ran.
 
     * - ScriptMissing: The specified script was not found in the specified
     * location.
 
     * - ScriptNotExecutable: The specified script is not a recognized
     * executable file type.
 
     * - ScriptTimedOut: The specified script did not finish running in the
     * specified time period.
 
     * - ScriptFailed: The specified script failed to run as expected.
 
     * - UnknownError: The specified script did not run for an unknown reason.
     * 
 
     * 
     * 
     * @return The associated error code:
     *         
     *         - Success: The specified script ran.
 
     *         - ScriptMissing: The specified script was not found in the
     *         specified location.
 
     *         - ScriptNotExecutable: The specified script is not a recognized
     *         executable file type.
 
     *         - ScriptTimedOut: The specified script did not finish running
     *         in the specified time period.
 
     *         - ScriptFailed: The specified script failed to run as expected.
     *         
 
     *         - UnknownError: The specified script did not run for an unknown
     *         reason.
 
     * @see LifecycleErrorCode
     */
    public String getErrorCode() {
        return this.errorCode;
    }
    /**
     * 
     * The associated error code:
     * 
     * 
     * - Success: The specified script ran.
 
     * - ScriptMissing: The specified script was not found in the specified
     * location.
 
     * - ScriptNotExecutable: The specified script is not a recognized
     * executable file type.
 
     * - ScriptTimedOut: The specified script did not finish running in the
     * specified time period.
 
     * - ScriptFailed: The specified script failed to run as expected.
 
     * - UnknownError: The specified script did not run for an unknown reason.
     * 
 
     * 
     * 
     * @param errorCode
     *        The associated error code:
     *        
     *        - Success: The specified script ran.
 
     *        - ScriptMissing: The specified script was not found in the
     *        specified location.
 
     *        - ScriptNotExecutable: The specified script is not a recognized
     *        executable file type.
 
     *        - ScriptTimedOut: The specified script did not finish running in
     *        the specified time period.
 
     *        - ScriptFailed: The specified script failed to run as expected.
 
     *        - UnknownError: The specified script did not run for an unknown
     *        reason.
 
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see LifecycleErrorCode
     */
    public Diagnostics withErrorCode(String errorCode) {
        setErrorCode(errorCode);
        return this;
    }
    /**
     * 
     * The associated error code:
     * 
     * 
     * - Success: The specified script ran.
 
     * - ScriptMissing: The specified script was not found in the specified
     * location.
 
     * - ScriptNotExecutable: The specified script is not a recognized
     * executable file type.
 
     * - ScriptTimedOut: The specified script did not finish running in the
     * specified time period.
 
     * - ScriptFailed: The specified script failed to run as expected.
 
     * - UnknownError: The specified script did not run for an unknown reason.
     * 
 
     * 
     * 
     * @param errorCode
     *        The associated error code:
     *        
     *        - Success: The specified script ran.
 
     *        - ScriptMissing: The specified script was not found in the
     *        specified location.
 
     *        - ScriptNotExecutable: The specified script is not a recognized
     *        executable file type.
 
     *        - ScriptTimedOut: The specified script did not finish running in
     *        the specified time period.
 
     *        - ScriptFailed: The specified script failed to run as expected.
 
     *        - UnknownError: The specified script did not run for an unknown
     *        reason.
 
     * @see LifecycleErrorCode
     */
    public void setErrorCode(LifecycleErrorCode errorCode) {
        this.errorCode = errorCode.toString();
    }
    /**
     * 
     * The associated error code:
     * 
     * 
     * - Success: The specified script ran.
 
     * - ScriptMissing: The specified script was not found in the specified
     * location.
 
     * - ScriptNotExecutable: The specified script is not a recognized
     * executable file type.
 
     * - ScriptTimedOut: The specified script did not finish running in the
     * specified time period.
 
     * - ScriptFailed: The specified script failed to run as expected.
 
     * - UnknownError: The specified script did not run for an unknown reason.
     * 
 
     * 
     * 
     * @param errorCode
     *        The associated error code:
     *        
     *        - Success: The specified script ran.
 
     *        - ScriptMissing: The specified script was not found in the
     *        specified location.
 
     *        - ScriptNotExecutable: The specified script is not a recognized
     *        executable file type.
 
     *        - ScriptTimedOut: The specified script did not finish running in
     *        the specified time period.
 
     *        - ScriptFailed: The specified script failed to run as expected.
 
     *        - UnknownError: The specified script did not run for an unknown
     *        reason.
 
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see LifecycleErrorCode
     */
    public Diagnostics withErrorCode(LifecycleErrorCode errorCode) {
        setErrorCode(errorCode);
        return this;
    }
    /**
     * 
     * The name of the script.
     * 
     * 
     * @param scriptName
     *        The name of the script.
     */
    public void setScriptName(String scriptName) {
        this.scriptName = scriptName;
    }
    /**
     * 
     * The name of the script.
     * 
     * 
     * @return The name of the script.
     */
    public String getScriptName() {
        return this.scriptName;
    }
    /**
     * 
     * The name of the script.
     * 
     * 
     * @param scriptName
     *        The name of the script.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public Diagnostics withScriptName(String scriptName) {
        setScriptName(scriptName);
        return this;
    }
    /**
     * 
     * The message associated with the error.
     * 
     * 
     * @param message
     *        The message associated with the error.
     */
    public void setMessage(String message) {
        this.message = message;
    }
    /**
     * 
     * The message associated with the error.
     * 
     * 
     * @return The message associated with the error.
     */
    public String getMessage() {
        return this.message;
    }
    /**
     * 
     * The message associated with the error.
     * 
     * 
     * @param message
     *        The message associated with the error.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public Diagnostics withMessage(String message) {
        setMessage(message);
        return this;
    }
    /**
     * 
     * The last portion of the diagnostic log.
     * 
     * 
     * If available, AWS CodeDeploy returns up to the last 4 KB of the
     * diagnostic log.
     * 
     * 
     * @param logTail
     *        The last portion of the diagnostic log.
     *        
     *        If available, AWS CodeDeploy returns up to the last 4 KB of the
     *        diagnostic log.
     */
    public void setLogTail(String logTail) {
        this.logTail = logTail;
    }
    /**
     * 
     * The last portion of the diagnostic log.
     * 
     * 
     * If available, AWS CodeDeploy returns up to the last 4 KB of the
     * diagnostic log.
     * 
     * 
     * @return The last portion of the diagnostic log.
     *         
     *         If available, AWS CodeDeploy returns up to the last 4 KB of the
     *         diagnostic log.
     */
    public String getLogTail() {
        return this.logTail;
    }
    /**
     * 
     * The last portion of the diagnostic log.
     * 
     * 
     * If available, AWS CodeDeploy returns up to the last 4 KB of the
     * diagnostic log.
     * 
     * 
     * @param logTail
     *        The last portion of the diagnostic log.
     *        
     *        If available, AWS CodeDeploy returns up to the last 4 KB of the
     *        diagnostic log.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public Diagnostics withLogTail(String logTail) {
        setLogTail(logTail);
        return this;
    }
    /**
     * Returns a string representation of this object; useful for testing and
     * debugging.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getErrorCode() != null)
            sb.append("ErrorCode: " + getErrorCode() + ",");
        if (getScriptName() != null)
            sb.append("ScriptName: " + getScriptName() + ",");
        if (getMessage() != null)
            sb.append("Message: " + getMessage() + ",");
        if (getLogTail() != null)
            sb.append("LogTail: " + getLogTail());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof Diagnostics == false)
            return false;
        Diagnostics other = (Diagnostics) obj;
        if (other.getErrorCode() == null ^ this.getErrorCode() == null)
            return false;
        if (other.getErrorCode() != null
                && other.getErrorCode().equals(this.getErrorCode()) == false)
            return false;
        if (other.getScriptName() == null ^ this.getScriptName() == null)
            return false;
        if (other.getScriptName() != null
                && other.getScriptName().equals(this.getScriptName()) == false)
            return false;
        if (other.getMessage() == null ^ this.getMessage() == null)
            return false;
        if (other.getMessage() != null
                && other.getMessage().equals(this.getMessage()) == false)
            return false;
        if (other.getLogTail() == null ^ this.getLogTail() == null)
            return false;
        if (other.getLogTail() != null
                && other.getLogTail().equals(this.getLogTail()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime * hashCode
                + ((getErrorCode() == null) ? 0 : getErrorCode().hashCode());
        hashCode = prime * hashCode
                + ((getScriptName() == null) ? 0 : getScriptName().hashCode());
        hashCode = prime * hashCode
                + ((getMessage() == null) ? 0 : getMessage().hashCode());
        hashCode = prime * hashCode
                + ((getLogTail() == null) ? 0 : getLogTail().hashCode());
        return hashCode;
    }
    @Override
    public Diagnostics clone() {
        try {
            return (Diagnostics) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException(
                    "Got a CloneNotSupportedException from Object.clone() "
                            + "even though we're Cloneable!", e);
        }
    }
}