Package org.jenkins.plugins.lockableresources

Class UpdateLockStep

java.lang.Object
hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>
org.jenkinsci.plugins.workflow.steps.Step
org.jenkins.plugins.lockableresources.UpdateLockStep
All Implemented Interfaces:
ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>, Serializable
public class UpdateLockStep extends org.jenkinsci.plugins.workflow.steps.Step implements Serializable
Pipeline step to update the definition of a lockable resource.

This step allows pipelines to:

  • Create new resources
  • Delete existing resources
  • Add, remove, or set labels on resources
  • Set notes on resources
See Also:

  • Constructor Details

    • UpdateLockStep

      @DataBoundConstructor public UpdateLockStep()

  • Method Details

    • getResource

      @CheckForNull public String getResource()

    • setResource

      @DataBoundSetter public void setResource(String resource)

    • getAddLabels

      @CheckForNull public String getAddLabels()

    • setAddLabels

      @DataBoundSetter public void setAddLabels(String addLabels)

    • getSetLabels

      @CheckForNull public String getSetLabels()

    • setSetLabels

      @DataBoundSetter public void setSetLabels(String setLabels)

    • getRemoveLabels

      @CheckForNull public String getRemoveLabels()

    • setRemoveLabels

      @DataBoundSetter public void setRemoveLabels(String removeLabels)

    • getSetNote

      @CheckForNull public String getSetNote()

    • setSetNote

      @DataBoundSetter public void setSetNote(String setNote)

    • isCreateResource

      public boolean isCreateResource()

    • setCreateResource

      @DataBoundSetter public void setCreateResource(boolean createResource)

    • isDeleteResource

      public boolean isDeleteResource()

    • setDeleteResource

      @DataBoundSetter public void setDeleteResource(boolean deleteResource)

    • validate

      public void validate()
      Validates the step configuration.
      Throws:
      IllegalArgumentException - if the configuration is invalid

    • 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

    • toString

      public String toString()
      Overrides:
      toString in class Object