Package se.diabol.jenkins.pipeline.flow

Class StageRestart

java.lang.Object

se.diabol.jenkins.pipeline.flow.StageRestart

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

DeclarativeStageRestart

public abstract class StageRestart
extends Object
implements ExtensionPoint

Restarts a finished Pipeline run from one of its top-level stages, for the flavours of Pipeline that support it. Declarative Pipeline does; the integration with it activates when that plugin is installed.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
StageRestart()

Method Summary

Modifier and Type	Method	Description
static ExtensionList<StageRestart>	all()
abstract void	restart(org.jenkinsci.plugins.workflow.job.WorkflowRun run, String stageName)	Schedules a run that restarts the given run from the named stage.
abstract Set<String>	restartableStages(org.jenkinsci.plugins.workflow.job.WorkflowRun run)	Names of the top-level stages the run can be restarted from by the current user; empty when it cannot.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StageRestart

public StageRestart()

Method Details

restartableStages

public abstract Set<String> restartableStages(org.jenkinsci.plugins.workflow.job.WorkflowRun run)

Names of the top-level stages the run can be restarted from by the current user; empty when it cannot.

restart

public abstract void restart(org.jenkinsci.plugins.workflow.job.WorkflowRun run,
 String stageName)
                      throws PipelineException

Schedules a run that restarts the given run from the named stage.

Throws:

PipelineException

all

public static ExtensionList<StageRestart> all()