Package org.jenkinsci.plugins.workflow.actions

Class WorkspaceAction

java.lang.Object

org.jenkinsci.plugins.workflow.actions.WorkspaceAction

All Implemented Interfaces:

Action, ModelObject, PersistentAction

public abstract class WorkspaceAction
extends Object
implements PersistentAction

Represents the fact that a step run on a particular workspace.

Constructor Summary

Constructors

Constructor	Description
WorkspaceAction()

Method Summary

Modifier and Type	Method	Description
abstract Set<LabelAtom>	getLabels()	The Node.getAssignedLabels() of the node owning the workspace.
abstract String	getNode()	The Node.getNodeName() of the workspace.
abstract String	getPath()	The FilePath.getRemote() of the workspace.
final FilePath	getWorkspace()	Reconstructs the live workspace, if possible.

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Action

getDisplayName, getIconFileName, getUrlName

Constructor Details

WorkspaceAction

public WorkspaceAction()

Method Details

getNode

@NonNull
public abstract String getNode()

The Node.getNodeName() of the workspace.

getPath

@NonNull
public abstract String getPath()

The FilePath.getRemote() of the workspace.

getLabels

@NonNull
public abstract Set<LabelAtom> getLabels()

The Node.getAssignedLabels() of the node owning the workspace. Node.getSelfLabel() should be exempted, so this set may be empty in the typical case. (Could be reconstructed in most cases via Jenkins.getNode(java.lang.String) on getNode(), but not for an agent which has since been removed, common with clouds.)

getWorkspace

@CheckForNull
public final FilePath getWorkspace()

Reconstructs the live workspace, if possible.