Package org.jenkinsci.plugins.workflow.multibranch

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 an SCM from a SCMSource 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	Our Descriptor.
static class	ResolveScmStep.Execution	Our StepExecution.

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

Modifier and Type	Method	Description
jenkins.scm.api.SCMSource	getSource()	Gets the SCMSource to resolve from.
List<String>	getTargets()	Gets the SCMHead names to try and resolve.
boolean	isIgnoreErrors()	Returns true 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()

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

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

ResolveScmStep

@DataBoundConstructor
public ResolveScmStep(@NonNull
 jenkins.scm.api.SCMSource source,
 @NonNull
 List<String> targets)

Constructor.

Parameters:

source - The SCMSource

targets - The SCMSource

Method Details

getSource

@NonNull
public jenkins.scm.api.SCMSource getSource()

Gets the SCMSource to resolve from.

Returns:

the SCMSource to resolve from.

getTargets

@NonNull
public List<String> getTargets()

Gets the SCMHead names to try and resolve.

Returns:

the SCMHead names to try and resolve.

isIgnoreErrors

public boolean isIgnoreErrors()

Returns true 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 class org.jenkinsci.plugins.workflow.steps.Step

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object