Package io.jenkins.plugins.util

Class PipelineResultHandler

java.lang.Object
io.jenkins.plugins.util.PipelineResultHandler
All Implemented Interfaces:
ResultHandler, StageResultHandler
public class PipelineResultHandler extends Object implements StageResultHandler, ResultHandler
A ResultHandler that sets the overall build result of the Run and annotates the given Pipeline stage with a WarningAction.
Author:
Devin Nusbaum

  • Constructor Details

    • PipelineResultHandler

      public PipelineResultHandler(Run<?,?> run, org.jenkinsci.plugins.workflow.graph.FlowNode flowNode)
      Creates a new instance of PipelineResultHandler.
      Parameters:
      run - the run to set the result for
      flowNode - the flow node to add a warning to

  • Method Details

    • setResult

      public void setResult(Result result, String message)
      Description copied from interface: StageResultHandler
      Called to set the Result of a stage.
      Specified by:
      setResult in interface StageResultHandler
      Parameters:
      result - the result to set
      message - a message that describes the cause for the result

    • publishResult

      public void publishResult(Result result, String message)
      Description copied from interface: ResultHandler
      Called to notify the build or stage about the new result.
      Specified by:
      publishResult in interface ResultHandler
      Parameters:
      result - the result
      message - a message that describes the cause for the result

    • publishResult

      public void publishResult(QualityGateStatus status, String message)
      Description copied from interface: ResultHandler
      Called to notify the build or stage about the result that is derived from a quality gate status.
      Specified by:
      publishResult in interface ResultHandler
      Parameters:
      status - the quality gate status
      message - a message that describes the cause for the result