Package com.xebialabs.deployit.engine.api.execution

Interface StepState

  • All Known Subinterfaces:
    StepStateLight
    public interface StepState
    Information about a step. A step is a concrete action to be performed to accomplish a task. XL Deploy ships with many step implementations for common actions. Other, middleware-specific steps are contributed by the plugins.

    • Method Detail

      • getDescription

        java.lang.String getDescription()
        Returns:
        Textual description of the step.

      • getLog

        java.lang.String getLog()
        Returns:
        The entire log output of the last attempt of the step. This may be long.

      • getPreviousAttemptsLogs

        java.util.List<java.lang.String> getPreviousAttemptsLogs()
        Returns:
        Lists the entire logs of all previous attempts of this step, if recorded; or null

      • getLogs

        default java.util.List<java.lang.String> getLogs()
        Returns:
        Lists the entire logs of all attempts. Combines getLog() and previousAttemptsLogs(). Never null.

      • getStartDate

        org.joda.time.DateTime getStartDate()
        Returns:
        The date when the step was started.

      • getCompletionDate

        org.joda.time.DateTime getCompletionDate()
        Returns:
        The date when the step was completed.

      • getFailureCount

        int getFailureCount()
        Returns:
        The number of times this step has failed.

      • getMetadata

        java.util.Map<java.lang.String,​java.lang.String> getMetadata()
        Returns:
        A map with step-specific entries (for example, the path to a script).

      • getSkippable

        boolean getSkippable()