Package hudson.plugins.throttleconcurrents

Class ThrottleJobProperty

java.lang.Object

hudson.model.JobProperty<Job<?,?>>

hudson.plugins.throttleconcurrents.ThrottleJobProperty

All Implemented Interfaces:

ExtensionPoint, Describable<JobProperty<?>>, ReconfigurableDescribable<JobProperty<?>>, BuildStep

public class ThrottleJobProperty
extends JobProperty<Job<?,?>>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ThrottleJobProperty.DescriptorImpl
static final class	ThrottleJobProperty.NodeLabeledPair
static final class	ThrottleJobProperty.ThrottleCategory

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.JobProperty

owner

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
ThrottleJobProperty(Integer maxConcurrentPerNode, Integer maxConcurrentTotal, List<String> categories, boolean throttleEnabled, String throttleOption, boolean limitOneJobWithMatchingParams, String paramsToUseForLimit, ThrottleMatrixProjectOptions matrixOptions)

Method Summary

Modifier and Type	Method	Description
static ThrottleJobProperty.DescriptorImpl	fetchDescriptor()
List<String>	getCategories()
ThrottleMatrixProjectOptions	getMatrixOptions()
Integer	getMaxConcurrentPerNode()
Integer	getMaxConcurrentTotal()
List<String>	getParamsToCompare()
String	getParamsToUseForLimit()
boolean	getThrottleEnabled()
String	getThrottleOption()
boolean	isLimitOneJobWithMatchingParams()
boolean	isThrottleMatrixBuilds()	Check if the build throttles MatrixProjects.
boolean	isThrottleMatrixConfigurations()	Check if the build throttles MatrixConfigurations.
Object	readResolve()	Migrates deprecated/obsolete data.
protected void	setOwner(Job<?,?> owner)

Methods inherited from class hudson.model.JobProperty

getDescriptor, getJobAction, getJobActions, getJobOverrides, getProjectAction, getProjectActions, getRequiredMonitorService, getSubTasks, perform, prebuild, reconfigure, reconfigure

Methods inherited from class java.lang.Object

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

Constructor Details

ThrottleJobProperty

@DataBoundConstructor
public ThrottleJobProperty(Integer maxConcurrentPerNode,
 Integer maxConcurrentTotal,
 List<String> categories,
 boolean throttleEnabled,
 String throttleOption,
 boolean limitOneJobWithMatchingParams,
 String paramsToUseForLimit,
 @CheckForNull
 ThrottleMatrixProjectOptions matrixOptions)

Method Details

readResolve

public Object readResolve()

Migrates deprecated/obsolete data.

Returns:

Migrated version of the config

setOwner

protected void setOwner(Job<?,?> owner)

Overrides:

setOwner in class JobProperty<Job<?,?>>

getThrottleEnabled

public boolean getThrottleEnabled()

isLimitOneJobWithMatchingParams

public boolean isLimitOneJobWithMatchingParams()

getThrottleOption

public String getThrottleOption()

getCategories

public List<String> getCategories()

getMaxConcurrentPerNode

public Integer getMaxConcurrentPerNode()

getMaxConcurrentTotal

public Integer getMaxConcurrentTotal()

getParamsToUseForLimit

public String getParamsToUseForLimit()

getMatrixOptions

@CheckForNull
public ThrottleMatrixProjectOptions getMatrixOptions()

isThrottleMatrixBuilds

public boolean isThrottleMatrixBuilds()

Check if the build throttles MatrixProjects.

Returns:

true if MatrixProjects should be throttled

Since:

1.8.3

isThrottleMatrixConfigurations

public boolean isThrottleMatrixConfigurations()

Check if the build throttles MatrixConfigurations.

Returns:

true if MatrixRuns should be throttled

Since:

1.8.3

getParamsToCompare

public List<String> getParamsToCompare()

fetchDescriptor

public static ThrottleJobProperty.DescriptorImpl fetchDescriptor()