Class ResolveScmStep
- java.lang.Object
-
- hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>
-
- org.jenkinsci.plugins.workflow.steps.Step
-
- org.jenkinsci.plugins.workflow.multibranch.ResolveScmStep
-
- All Implemented Interfaces:
ExtensionPoint
,Describable<org.jenkinsci.plugins.workflow.steps.Step>
public class ResolveScmStep extends org.jenkinsci.plugins.workflow.steps.Step
Resolves anSCM
from aSCMSource
using a priority list of target branch names.- Since:
- 2.10
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ResolveScmStep.DescriptorImpl
OurDescriptor
.static class
ResolveScmStep.Execution
OurStepExecution
.-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Constructor Summary
Constructors Constructor Description ResolveScmStep(jenkins.scm.api.SCMSource source, List<String> targets)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description jenkins.scm.api.SCMSource
getSource()
Gets theSCMSource
to resolve from.List<String>
getTargets()
Gets theSCMHead
names to try and resolve.boolean
isIgnoreErrors()
Returnstrue
if and only if errors will be ignored.void
setIgnoreErrors(boolean ignoreErrors)
Sets the error handling behaviour.org.jenkinsci.plugins.workflow.steps.StepExecution
start(org.jenkinsci.plugins.workflow.steps.StepContext context)
String
toString()
-
-
-
Method Detail
-
getSource
@NonNull public jenkins.scm.api.SCMSource getSource()
Gets theSCMSource
to resolve from.- Returns:
- the
SCMSource
to resolve from.
-
getTargets
@NonNull public List<String> getTargets()
Gets theSCMHead
names to try and resolve.- Returns:
- the
SCMHead
names to try and resolve.
-
isIgnoreErrors
public boolean isIgnoreErrors()
Returnstrue
if and only if errors will be ignored.- Returns:
true
if and only if errors will be ignored.
-
setIgnoreErrors
@DataBoundSetter public void setIgnoreErrors(boolean ignoreErrors)
Sets the error handling behaviour.- Parameters:
ignoreErrors
-true
if and only if errors will be ignored.
-
start
public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context) throws Exception
- Specified by:
start
in classorg.jenkinsci.plugins.workflow.steps.Step
- Throws:
Exception
-
-