Package io.jenkins.plugins.multibranchparams

Class ParameterizedBranchProperty

java.lang.Object

hudson.model.AbstractDescribableImpl<jenkins.branch.BranchProperty>

jenkins.branch.BranchProperty

io.jenkins.plugins.multibranchparams.ParameterizedBranchProperty

All Implemented Interfaces:

ExtensionPoint, Describable<jenkins.branch.BranchProperty>

public class ParameterizedBranchProperty
extends jenkins.branch.BranchProperty

A BranchProperty that injects build parameters into every branch job of a Multibranch Pipeline from the UI, without touching individual Jenkinsfiles.

Attach this property via:

• Multibranch Pipeline → Configure → Branch Sources → Property strategy → All branches get the same properties → Add property → Branch Parameters
• Or use ParameterizedBranchPropertyStrategy for regex-based filtering.

Parameter policy

The parameterPolicy field controls how plugin-defined parameters interact with any parameters {} block in the Jenkinsfile. See ParameterPolicy for a full description of each mode.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParameterizedBranchProperty.DescriptorImpl	Jenkins extension descriptor for ParameterizedBranchProperty.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
ParameterizedBranchProperty()	Required by Stapler for data binding.

Method Summary

Modifier and Type	Method	Description
List<ParameterDefinition>	getParameterDefinitions()
ParameterPolicy	getParameterPolicy()
<P extends Job<P, B>, B extends Run<P, B>> jenkins.branch.JobDecorator<P,B>	jobDecorator(Class<P> clazz)
void	setParameterDefinitions(List<ParameterDefinition> parameterDefinitions)
void	setParameterPolicy(ParameterPolicy parameterPolicy)

Methods inherited from class jenkins.branch.BranchProperty

asArrayList, decorator, decorator, getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

ParameterizedBranchProperty

@DataBoundConstructor
public ParameterizedBranchProperty()

Required by Stapler for data binding.

Method Details

getParameterDefinitions

public List<ParameterDefinition> getParameterDefinitions()

setParameterDefinitions

@DataBoundSetter
public void setParameterDefinitions(@NonNull
 List<ParameterDefinition> parameterDefinitions)

getParameterPolicy

public ParameterPolicy getParameterPolicy()

setParameterPolicy

@DataBoundSetter
public void setParameterPolicy(@NonNull
 ParameterPolicy parameterPolicy)

jobDecorator

public <P extends Job<P,
B>,
B extends Run<P,
B>>
jenkins.branch.JobDecorator<P,B> jobDecorator(Class<P> clazz)

Overrides:

jobDecorator in class jenkins.branch.BranchProperty