Package org.jenkins.plugins.lockableresources.queue

Class LockableResourcesStruct

java.lang.Object

org.jenkins.plugins.lockableresources.queue.LockableResourcesStruct

All Implemented Interfaces:

Serializable

public class LockableResourcesStruct
extends Object
implements Serializable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	label
long	queuedAt
List<LockableResource>	required
String	requiredNumber
String	requiredVar

Constructor Summary

Constructors

Constructor	Description
LockableResourcesStruct(List<String> resources)	Light-weight constructor for declaring a resource only.
LockableResourcesStruct(List<String> resources, String label, int quantity)
LockableResourcesStruct(List<String> resources, String label, int quantity, String variable)
LockableResourcesStruct(RequiredResourcesProperty property, EnvVars env)

Method Summary

Modifier and Type	Method	Description
String	getGroup()
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	getResourceMatchScriptText()
boolean	isGroupOnly()
boolean	isResourceRequired(LockableResource resource)	Check if the *resource* is required by this struct / queue
void	setGroup(String group)
void	setGroupOnly(boolean groupOnly)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

required

public List<LockableResource> required

label

public String label

requiredVar

public String requiredVar

requiredNumber

public String requiredNumber

queuedAt

public long queuedAt

Constructor Details

LockableResourcesStruct

public LockableResourcesStruct(RequiredResourcesProperty property,
 EnvVars env)

LockableResourcesStruct

public LockableResourcesStruct(@Nullable
 List<String> resources)

Light-weight constructor for declaring a resource only.

Parameters:

resources - Resources to be required

LockableResourcesStruct

public LockableResourcesStruct(@Nullable
 List<String> resources,
 @Nullable
 String label,
 int quantity,
 String variable)

LockableResourcesStruct

public LockableResourcesStruct(@Nullable
 List<String> resources,
 @Nullable
 String label,
 int quantity)

Method Details

isGroupOnly

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public boolean isGroupOnly()

Since:

TODO

setGroupOnly

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void setGroupOnly(boolean groupOnly)

Since:

TODO

getGroup

public String getGroup()

Since:

TODO

setGroup

public void setGroup(String group)

Since:

TODO

getResourceMatchScript

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

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

Returns:

System Groovy Script if defined

Throws:

Descriptor.FormException

Since:

2.1

See Also:

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

getResourceMatchScriptText

@CheckForNull
public String getResourceMatchScriptText()

toString

public String toString()

Overrides:

toString in class Object

isResourceRequired

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public boolean isResourceRequired(LockableResource resource)

Check if the *resource* is required by this struct / queue