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

Class InputStep

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

org.jenkinsci.plugins.workflow.steps.AbstractStepImpl

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

All Implemented Interfaces:

ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>, Serializable

@ExportedBean(defaultVisibility=2)
public class InputStep
extends org.jenkinsci.plugins.workflow.steps.AbstractStepImpl
implements Serializable

Step that pauses for human input.

Author:

Kohsuke Kawaguchi

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InputStep.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
InputStep(String message)

Method Summary

Modifier and Type	Method	Description
boolean	canSettle(Authentication a)	Deprecated.
boolean	canSubmit()	Deprecated.
String	getCancel()	Caption of the Cancel button.
InputStep.DescriptorImpl	getDescriptor()
String	getId()
String	getMessage()
String	getOk()	Caption of the OK button.
List<ParameterDefinition>	getParameters()
String	getSubmitter()
String	getSubmitterParameter()
void	setCancel(String cancel)
void	setId(String id)
void	setOk(String ok)
void	setParameters(List<ParameterDefinition> parameters)
void	setSubmitter(String submitter)
void	setSubmitterParameter(String submitterParameter)
org.jenkinsci.plugins.workflow.steps.StepExecution	start(org.jenkinsci.plugins.workflow.steps.StepContext context)

Methods inherited from class org.jenkinsci.plugins.workflow.steps.AbstractStepImpl

prepareInjector

Methods inherited from class java.lang.Object

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

Constructor Details

InputStep

@DataBoundConstructor
public InputStep(String message)

Method Details

setId

@DataBoundSetter
public void setId(String id)

getId

@Exported
public String getId()

getSubmitter

@Exported
public String getSubmitter()

setSubmitter

@DataBoundSetter
public void setSubmitter(String submitter)

getSubmitterParameter

@Exported
public String getSubmitterParameter()

setSubmitterParameter

@DataBoundSetter
public void setSubmitterParameter(String submitterParameter)

getCancel

@Exported
public String getCancel()

Caption of the Cancel button.

setCancel

@DataBoundSetter
public void setCancel(String cancel)

getOk

@Exported
public String getOk()

Caption of the OK button.

setOk

@DataBoundSetter
public void setOk(String ok)

getParameters

@Exported
public List<ParameterDefinition> getParameters()

setParameters

@DataBoundSetter
public void setParameters(List<ParameterDefinition> parameters)

getMessage

@Exported
public String getMessage()

canSubmit

@Deprecated
public boolean canSubmit()

Deprecated.

canSettle

@Deprecated
public boolean canSettle(Authentication a)

Deprecated.

Checks if the given user can settle this input.

start

public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context)
                                                         throws Exception

Overrides:

start in class org.jenkinsci.plugins.workflow.steps.AbstractStepImpl

Throws:

Exception

getDescriptor

public InputStep.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<org.jenkinsci.plugins.workflow.steps.Step>

Overrides:

getDescriptor in class org.jenkinsci.plugins.workflow.steps.Step