Package org.jenkinsci.plugins.workflow.support.steps.input

Class InputAction

java.lang.Object

org.jenkinsci.plugins.workflow.support.steps.input.InputAction

All Implemented Interfaces:

Action, ModelObject, RunAction2

@ExportedBean
public class InputAction
extends Object
implements RunAction2

Records the pending inputs required.

Constructor Summary

Constructors

Constructor	Description
InputAction()

Method Summary

Modifier and Type	Method	Description
void	add(InputStepExecution step)
String	getDisplayName()
InputStepExecution	getDynamic(String token)	Bind steps just by their ID names.
InputStepExecution	getExecution(String id)
List<InputStepExecution>	getExecutions()
String	getIconFileName()
Run<?,?>	getRun()
String	getUrlName()
boolean	isWaitingForInput()
void	onAttached(Run<?,?> r)
void	onLoad(Run<?,?> r)
void	remove(InputStepExecution exec)	Called when InputStepExecution is completed to remove it from the active input list.

Methods inherited from class java.lang.Object

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

Constructor Detail

InputAction

public InputAction()

Method Detail

onAttached

public void onAttached(Run<?,?> r)

Specified by:

onAttached in interface RunAction2

onLoad

public void onLoad(Run<?,?> r)

Specified by:

onLoad in interface RunAction2

getRun

public Run<?,?> getRun()

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

getDisplayName

@Exported
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

add

public void add(@NonNull
                InputStepExecution step)
         throws IOException,
                InterruptedException,
                TimeoutException

Throws:

IOException

InterruptedException

TimeoutException

getExecution

public InputStepExecution getExecution(String id)
                                throws InterruptedException,
                                       TimeoutException

Throws:

InterruptedException

TimeoutException

getExecutions

@Exported
public List<InputStepExecution> getExecutions()
                                       throws InterruptedException,
                                              TimeoutException

Throws:

InterruptedException

TimeoutException

isWaitingForInput

@Exported
public boolean isWaitingForInput()
                          throws InterruptedException,
                                 TimeoutException

Throws:

InterruptedException

TimeoutException

remove

public void remove(InputStepExecution exec)
            throws IOException,
                   InterruptedException,
                   TimeoutException

Called when InputStepExecution is completed to remove it from the active input list.

Throws:

IOException

InterruptedException

TimeoutException

getDynamic

public InputStepExecution getDynamic(String token)
                              throws InterruptedException,
                                     TimeoutException

Bind steps just by their ID names.

Throws:

InterruptedException

TimeoutException