Class LockStep
- java.lang.Object
-
- hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>
-
- org.jenkinsci.plugins.workflow.steps.Step
-
- org.jenkins.plugins.lockableresources.LockStep
-
- All Implemented Interfaces:
ExtensionPoint
,Describable<org.jenkinsci.plugins.workflow.steps.Step>
,Serializable
public class LockStep extends org.jenkinsci.plugins.workflow.steps.Step implements Serializable
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
LockStep.DescriptorImpl
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Field Summary
Fields Modifier and Type Field Description List<LockStepResource>
extra
boolean
inversePrecedence
String
label
int
priority
int
quantity
String
resource
String
resourceSelectStrategy
boolean
skipIfLocked
String
variable
name of environment variable to store locked resources in
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<LockStepResource>
getResources()
void
setExtra(List<LockStepResource> extra)
void
setInversePrecedence(boolean inversePrecedence)
void
setLabel(String label)
void
setPriority(int priority)
void
setQuantity(int quantity)
void
setResourceSelectStrategy(String resourceSelectStrategy)
void
setSkipIfLocked(boolean skipIfLocked)
void
setVariable(String variable)
org.jenkinsci.plugins.workflow.steps.StepExecution
start(org.jenkinsci.plugins.workflow.steps.StepContext context)
String
toString()
void
validate()
Label and resource are mutual exclusive.
-
-
-
Field Detail
-
resource
@CheckForNull public String resource
-
label
@CheckForNull public String label
-
quantity
public int quantity
-
variable
@CheckForNull public String variable
name of environment variable to store locked resources in
-
inversePrecedence
public boolean inversePrecedence
-
resourceSelectStrategy
public String resourceSelectStrategy
-
skipIfLocked
public boolean skipIfLocked
-
extra
@CheckForNull public List<LockStepResource> extra
-
priority
public int priority
-
-
Constructor Detail
-
LockStep
@DataBoundConstructor public LockStep(@Nullable String resource)
-
-
Method Detail
-
setInversePrecedence
@DataBoundSetter public void setInversePrecedence(boolean inversePrecedence)
-
setResourceSelectStrategy
@DataBoundSetter public void setResourceSelectStrategy(String resourceSelectStrategy)
-
setSkipIfLocked
@DataBoundSetter public void setSkipIfLocked(boolean skipIfLocked)
-
setLabel
@DataBoundSetter public void setLabel(String label)
-
setVariable
@DataBoundSetter public void setVariable(String variable)
-
setQuantity
@DataBoundSetter public void setQuantity(int quantity)
-
setPriority
@DataBoundSetter public void setPriority(int priority)
-
setExtra
@DataBoundSetter public void setExtra(@CheckForNull List<LockStepResource> extra)
-
validate
public void validate()
Label and resource are mutual exclusive.
-
getResources
public List<LockStepResource> getResources()
-
start
public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context)
- Specified by:
start
in classorg.jenkinsci.plugins.workflow.steps.Step
-
-