Package org.jenkins.plugins.lockableresources

Class RequiredResourcesProperty

java.lang.Object

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

org.jenkins.plugins.lockableresources.RequiredResourcesProperty

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RequiredResourcesProperty.DescriptorImpl

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
RequiredResourcesProperty(String resourceNames, String resourceNamesVar, String resourceNumber, String labelName)	Deprecated. groovy script was added (since 2.0)
RequiredResourcesProperty(String resourceNames, String resourceNamesVar, String resourceNumber, String labelName, org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SecureGroovyScript resourceMatchScript)

Method Summary

Modifier and Type	Method	Description
String	getLabelName()
long	getLockTimeout()
String	getLockTimeoutUnit()
org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SecureGroovyScript	getResourceMatchScript()	Gets a system Groovy script to be executed in order to determine if the LockableResource matches the condition.
String	getResourceNames()
String	getResourceNamesVar()
String	getResourceNumber()
String[]	getResources()
void	setLockTimeout(long lockTimeout)
void	setLockTimeoutUnit(String lockTimeoutUnit)

Methods inherited from class hudson.model.JobProperty

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

Methods inherited from class java.lang.Object

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

Constructor Details

RequiredResourcesProperty

@DataBoundConstructor
public RequiredResourcesProperty(String resourceNames,
 String resourceNamesVar,
 String resourceNumber,
 String labelName,
 @CheckForNull
 org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SecureGroovyScript resourceMatchScript)
                          throws Descriptor.FormException

Throws:

Descriptor.FormException

RequiredResourcesProperty

@Deprecated
public RequiredResourcesProperty(String resourceNames,
 String resourceNamesVar,
 String resourceNumber,
 String labelName)
                          throws Descriptor.FormException

Deprecated.

groovy script was added (since 2.0)

Throws:

Descriptor.FormException

Method Details

getResources

public String[] getResources()

getResourceNames

public String getResourceNames()

getResourceNamesVar

public String getResourceNamesVar()

getResourceNumber

public String getResourceNumber()

getLabelName

public String getLabelName()

getResourceMatchScript

@CheckForNull
public org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SecureGroovyScript getResourceMatchScript()

Gets a system Groovy script to be executed in order to determine if the LockableResource matches the condition.

Returns:

System Groovy Script if defined

Since:

2.0

See Also:

• LockableResource.scriptMatches(org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SecureGroovyScript, java.util.Map)

getLockTimeout

public long getLockTimeout()

setLockTimeout

@DataBoundSetter
public void setLockTimeout(long lockTimeout)

getLockTimeoutUnit

public String getLockTimeoutUnit()

setLockTimeoutUnit

@DataBoundSetter
public void setLockTimeoutUnit(String lockTimeoutUnit)