Class Diagnostics

    • Constructor Detail

      • Diagnostics

        public Diagnostics()
    • Method Detail

      • setErrorCode

        public void setErrorCode​(String 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.
        Parameters:
        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 Also:
        LifecycleErrorCode
      • getErrorCode

        public String getErrorCode()

        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.
        Returns:
        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 Also:
        LifecycleErrorCode
      • withErrorCode

        public Diagnostics withErrorCode​(String 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.
        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LifecycleErrorCode
      • setErrorCode

        public void setErrorCode​(LifecycleErrorCode 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.
        Parameters:
        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 Also:
        LifecycleErrorCode
      • withErrorCode

        public Diagnostics withErrorCode​(LifecycleErrorCode 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.
        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LifecycleErrorCode
      • setScriptName

        public void setScriptName​(String scriptName)

        The name of the script.

        Parameters:
        scriptName - The name of the script.
      • getScriptName

        public String getScriptName()

        The name of the script.

        Returns:
        The name of the script.
      • withScriptName

        public Diagnostics withScriptName​(String scriptName)

        The name of the script.

        Parameters:
        scriptName - The name of the script.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setMessage

        public void setMessage​(String message)

        The message associated with the error.

        Parameters:
        message - The message associated with the error.
      • getMessage

        public String getMessage()

        The message associated with the error.

        Returns:
        The message associated with the error.
      • withMessage

        public Diagnostics withMessage​(String message)

        The message associated with the error.

        Parameters:
        message - The message associated with the error.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setLogTail

        public void setLogTail​(String logTail)

        The last portion of the diagnostic log.

        If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log.

        Parameters:
        logTail - The last portion of the diagnostic log.

        If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log.

      • getLogTail

        public String getLogTail()

        The last portion of the diagnostic log.

        If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log.

        Returns:
        The last portion of the diagnostic log.

        If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log.

      • withLogTail

        public Diagnostics withLogTail​(String logTail)

        The last portion of the diagnostic log.

        If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log.

        Parameters:
        logTail - The last portion of the diagnostic log.

        If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object