Package org.jenkins.plugins.lockableresources

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:

  • Field Details

    • resource

      @CheckForNull public String resource

    • label

      @CheckForNull public String label

    • reason

      @CheckForNull public String reason
      The reason why this resource is being locked, displayed in the UI while locked.

    • 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

    • timeoutForAllocateResource

      public long timeoutForAllocateResource
      Timeout in the specified timeoutUnit for waiting to acquire the resource. 0 means no timeout (wait indefinitely). When the timeout expires, the step fails with an exception instead of waiting forever.

    • timeoutUnit

      public String timeoutUnit
      Time unit for timeoutForAllocateResource. Defaults to MINUTES.

  • Constructor Details

    • LockStep

      @DataBoundConstructor public LockStep(@Nullable String resource)

  • Method Details

    • 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)

    • setReason

      @DataBoundSetter public void setReason(String reason)

    • 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)

    • setTimeoutForAllocateResource

      @DataBoundSetter public void setTimeoutForAllocateResource(long timeoutForAllocateResource)

    • setTimeoutUnit

      @DataBoundSetter public void setTimeoutUnit(String timeoutUnit)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validate

      public void validate(boolean allowEmptyOrNullValues)
      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 class org.jenkinsci.plugins.workflow.steps.Step