Package org.jenkins.plugins.lockableresources.queue

Class QueuedContextStruct

java.lang.Object

org.jenkins.plugins.lockableresources.queue.QueuedContextStruct

All Implemented Interfaces:

Serializable

public class QueuedContextStruct
extends Object
implements Serializable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
List<String>	candidates

Constructor Summary

Constructors

Constructor	Description
QueuedContextStruct(org.jenkinsci.plugins.workflow.steps.StepContext context, List<LockableResourcesStruct> lockableResourcesStruct, String resourceDescription, String variableName, int priority)
QueuedContextStruct(org.jenkinsci.plugins.workflow.steps.StepContext context, List<LockableResourcesStruct> lockableResourcesStruct, String resourceDescription, String variableName, int priority, String reason, long timeoutForAllocateResource, String timeoutUnit)

Method Summary

Modifier and Type	Method	Description
int	compare(QueuedContextStruct other)
Run<?,?>	getBuild()	Return build, where is the resource used.
org.jenkinsci.plugins.workflow.steps.StepContext	getContext()
String	getId()
PrintStream	getLogger()
int	getPriority()
String	getReason()
String	getResourceDescription()
List<LockableResourcesStruct>	getResources()
long	getTimeoutDeadlineMillis()	Returns the pre-computed deadline (epoch millis) when this entry times out.
long	getTimeoutForAllocateResource()	Returns the configured timeout for resource allocation.
String	getTimeoutUnit()	Returns the time unit for the allocation timeout.
String	getVariableName()
boolean	isTimedOut()	Checks whether this queued context has exceeded its allocation timeout.
boolean	isValid()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

candidates

public transient List<String> candidates

Constructor Details

QueuedContextStruct

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public QueuedContextStruct(org.jenkinsci.plugins.workflow.steps.StepContext context,
 List<LockableResourcesStruct> lockableResourcesStruct,
 String resourceDescription,
 String variableName,
 int priority)

QueuedContextStruct

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public QueuedContextStruct(org.jenkinsci.plugins.workflow.steps.StepContext context,
 List<LockableResourcesStruct> lockableResourcesStruct,
 String resourceDescription,
 String variableName,
 int priority,
 String reason,
 long timeoutForAllocateResource,
 String timeoutUnit)

Method Details

compare

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public int compare(QueuedContextStruct other)

getPriority

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public int getPriority()

getId

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public String getId()

getContext

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public org.jenkinsci.plugins.workflow.steps.StepContext getContext()

getBuild

@CheckForNull
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public Run<?,?> getBuild()

Return build, where is the resource used.

isValid

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

getResources

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public List<LockableResourcesStruct> getResources()

getResourceDescription

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public String getResourceDescription()

getVariableName

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public String getVariableName()

isTimedOut

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

Checks whether this queued context has exceeded its allocation timeout. Uses a pre-computed deadline for performance since this is called on every queue check.

Returns:

true if a timeout was set and has expired, false otherwise

getTimeoutDeadlineMillis

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public long getTimeoutDeadlineMillis()

Returns the pre-computed deadline (epoch millis) when this entry times out. 0 means no timeout is configured.

getTimeoutForAllocateResource

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public long getTimeoutForAllocateResource()

Returns the configured timeout for resource allocation.

getTimeoutUnit

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public String getTimeoutUnit()

Returns the time unit for the allocation timeout.

getReason

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public String getReason()

toString

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public String toString()

Overrides:

toString in class Object

getLogger

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public PrintStream getLogger()