Package io.jenkins.plugins.explain_error

Class ConsoleExplainErrorAction

java.lang.Object
io.jenkins.plugins.explain_error.ConsoleExplainErrorAction
All Implemented Interfaces:
Action, ModelObject, RunAction2
public class ConsoleExplainErrorAction extends Object implements RunAction2
Action to add "Explain Error" functionality to console output pages. This action needs to be manually added to builds.

  • Constructor Details

    • ConsoleExplainErrorAction

      public ConsoleExplainErrorAction(Run<?,?> run)

  • Method Details

    • onAttached

      public void onAttached(Run<?,?> r)
      Specified by:
      onAttached in interface RunAction2

    • onLoad

      public void onLoad(Run<?,?> r)
      Specified by:
      onLoad in interface RunAction2

    • getIconFileName

      public String getIconFileName()
      Specified by:
      getIconFileName in interface Action

    • getDisplayName

      public String getDisplayName()
      Specified by:
      getDisplayName in interface Action
      Specified by:
      getDisplayName in interface ModelObject

    • getUrlName

      public String getUrlName()
      Specified by:
      getUrlName in interface Action

    • doExplainConsoleError

      public void doExplainConsoleError(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp) throws IOException
      AJAX endpoint to explain error from console output. Called via JavaScript from the console output page.
      Throws:
      IOException

    • doCheckBuildStatus

      public void doCheckBuildStatus(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
      AJAX endpoint to check build status. Returns JSON with buildingStatus to determine if button should be shown. 0 - SUCCESS, 1 - RUNNING, 2 - FINISHED and FAILURE It also carries explanation, which says whether the build has one: "ready", "pending" (an automatic one has been requested and has not come back yet) or "none".

    • getExplanationState

      public String getExplanationState()
      Whether the build has an explanation: "ready", "pending" or "none".

    • isExplanationPending

      public boolean isExplanationPending()
      Whether an automatic explanation of this build has been requested and has not come back yet.

    • getRun

      public Run<?,?> getRun()