Package org.jenkinsci.plugins.workflow.support.steps

Class ExecutorStepExecution.PlaceholderTask

java.lang.Object

org.jenkinsci.plugins.workflow.support.steps.ExecutorStepExecution.PlaceholderTask

All Implemented Interfaces:

ModelObject, SubTask, Queue.Task, ResourceActivity, AccessControlled, Serializable, org.jenkinsci.plugins.durabletask.executors.ContinuedTask

Enclosing class:

ExecutorStepExecution

@ExportedBean
public static final class ExecutorStepExecution.PlaceholderTask
extends Object
implements org.jenkinsci.plugins.durabletask.executors.ContinuedTask, Serializable, AccessControlled

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExecutorStepExecution.PlaceholderTask.AuthenticationFromBuild
static final class	ExecutorStepExecution.PlaceholderTask.EnforceSelfLabel
final class	ExecutorStepExecution.PlaceholderTask.PlaceholderExecutable	Occupies Executor while workflow uses this build agent.

Nested classes/interfaces inherited from interface org.jenkinsci.plugins.durabletask.executors.ContinuedTask

org.jenkinsci.plugins.durabletask.executors.ContinuedTask.Scheduler

Method Summary

Modifier and Type	Method	Description
void	checkAbortPermission()
Queue.Executable	createExecutable()
boolean	equals(Object obj)
ACL	getACL()	Something we can use to check abort and read permissions.
String	getAffinityKey()	Provide unique key which will be used to prioritize the list of possible build agents to use
Label	getAssignedLabel()
CauseOfBlockage	getCauseOfBlockage()
Authentication	getDefaultAuthentication()
Authentication	getDefaultAuthentication(Queue.Item item)
String	getDisplayName()
String	getEnclosingLabel()
long	getEstimatedDuration()
String	getFullDisplayName()
Node	getLastBuiltOn()
String	getName()
org.jenkinsci.plugins.workflow.graph.FlowNode	getNode()	Gives FlowNode, waiting to be executed in build Queue.
Queue.Executable	getOwnerExecutable()
Queue.Task	getOwnerTask()
ResourceList	getResourceList()
Object	getSameNodeConstraint()
Collection<? extends SubTask>	getSubTasks()
String	getUrl()
String	getWhyBlocked()	Deprecated.
boolean	hasAbortPermission()
int	hashCode()
boolean	hasStarted()	Body has begun execution: we started using a node.
boolean	isBuildBlocked()	Deprecated.
boolean	isConcurrentBuild()
boolean	isContinued()
Run<?,?>	run()	Deprecated. use getOwnerExecutable() (which does not require a dependency on this plugin) if your core dep is 2.389+
Run<?,?>	runForDisplay()	Deprecated. use getOwnerExecutable() (which does not require a dependency on this plugin) if your core dep is 2.389+
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface hudson.security.AccessControlled

checkAnyPermission, checkPermission, hasAnyPermission, hasPermission, hasPermission, hasPermission2

Methods inherited from interface hudson.model.Queue.Task

getDefaultAuthentication2, getDefaultAuthentication2

Method Details

getNode

@CheckForNull
public org.jenkinsci.plugins.workflow.graph.FlowNode getNode()
                                                      throws IOException,
InterruptedException

Gives FlowNode, waiting to be executed in build Queue.

Returns:

FlowNode instance, could be null.

Throws:

IOException

InterruptedException

createExecutable

public Queue.Executable createExecutable()
                                  throws IOException

Specified by:

createExecutable in interface SubTask

Throws:

IOException

hasStarted

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

Body has begun execution: we started using a node.

getAssignedLabel

public Label getAssignedLabel()

Specified by:

getAssignedLabel in interface SubTask

getLastBuiltOn

public Node getLastBuiltOn()

Specified by:

getLastBuiltOn in interface SubTask

isBuildBlocked

@Deprecated
public boolean isBuildBlocked()

Deprecated.

Specified by:

isBuildBlocked in interface Queue.Task

getWhyBlocked

@Deprecated
public String getWhyBlocked()

Deprecated.

Specified by:

getWhyBlocked in interface Queue.Task

getCauseOfBlockage

public CauseOfBlockage getCauseOfBlockage()

Specified by:

getCauseOfBlockage in interface Queue.Task

isConcurrentBuild

public boolean isConcurrentBuild()

Specified by:

isConcurrentBuild in interface Queue.Task

getSubTasks

public Collection<? extends SubTask> getSubTasks()

Specified by:

getSubTasks in interface Queue.Task

getOwnerTask

@NonNull
public Queue.Task getOwnerTask()

Specified by:

getOwnerTask in interface SubTask

getSameNodeConstraint

public Object getSameNodeConstraint()

Specified by:

getSameNodeConstraint in interface SubTask

getACL

@NonNull
public ACL getACL()

Something we can use to check abort and read permissions. Normally this will be a Run. If that has been deleted, we can fall back to the Job. If things are badly broken, for example if the whole job has been deleted, then as a fallback we use the Jenkins root. This allows an administrator to clean up dead queue items and executor cells.

Specified by:

getACL in interface AccessControlled

checkAbortPermission

public void checkAbortPermission()

Specified by:

checkAbortPermission in interface Queue.Task

hasAbortPermission

public boolean hasAbortPermission()

Specified by:

hasAbortPermission in interface Queue.Task

run

@Deprecated
@CheckForNull
public Run<?,?> run()

Deprecated.

use getOwnerExecutable() (which does not require a dependency on this plugin) if your core dep is 2.389+

runForDisplay

@Deprecated
@CheckForNull
public Run<?,?> runForDisplay()

Deprecated.

use getOwnerExecutable() (which does not require a dependency on this plugin) if your core dep is 2.389+

getOwnerExecutable

@CheckForNull
public Queue.Executable getOwnerExecutable()

Specified by:

getOwnerExecutable in interface SubTask

getUrl

@Exported
public String getUrl()

Specified by:

getUrl in interface Queue.Task

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface ModelObject

Specified by:

getDisplayName in interface ResourceActivity

getName

@Exported
public String getName()

Specified by:

getName in interface Queue.Task

getFullDisplayName

@Exported
public String getFullDisplayName()

Specified by:

getFullDisplayName in interface Queue.Task

getAffinityKey

public String getAffinityKey()

Provide unique key which will be used to prioritize the list of possible build agents to use

Specified by:

getAffinityKey in interface Queue.Task

getEnclosingLabel

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

getEstimatedDuration

public long getEstimatedDuration()

Specified by:

getEstimatedDuration in interface SubTask

getResourceList

public ResourceList getResourceList()

Specified by:

getResourceList in interface ResourceActivity

getDefaultAuthentication

@NonNull
public Authentication getDefaultAuthentication()

Specified by:

getDefaultAuthentication in interface Queue.Task

getDefaultAuthentication

@NonNull
public Authentication getDefaultAuthentication(Queue.Item item)

Specified by:

getDefaultAuthentication in interface Queue.Task

isContinued

public boolean isContinued()

Specified by:

isContinued in interface org.jenkinsci.plugins.durabletask.executors.ContinuedTask

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object