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

Class WorkspaceStep

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

org.jenkinsci.plugins.workflow.support.steps.WorkspaceStep

All Implemented Interfaces:

ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>

public final class WorkspaceStep
extends org.jenkinsci.plugins.workflow.steps.Step

Allocates a workspace on the current node and uses that as the default directory for nested steps. ExecutorStep already does so, but this may be used to allocate additional workspaces.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	WorkspaceStep.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
WorkspaceStep(String dir)

Method Summary

Modifier and Type	Method	Description
String	getDir()
org.jenkinsci.plugins.workflow.steps.StepExecution	start(org.jenkinsci.plugins.workflow.steps.StepContext context)

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

WorkspaceStep

@DataBoundConstructor
public WorkspaceStep(String dir)

Method Details

getDir

public String getDir()

start

public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context)
                                                         throws Exception

Specified by:

start in class org.jenkinsci.plugins.workflow.steps.Step

Throws:

Exception