Package com.atlassian.bamboo.specs.builders.task

Class ScriptTask

java.lang.Object

com.atlassian.bamboo.specs.api.builders.EntityPropertiesBuilder<P>

com.atlassian.bamboo.specs.api.builders.task.Task<ScriptTask,ScriptTaskProperties>

com.atlassian.bamboo.specs.builders.task.ScriptTask

public class ScriptTask
extends Task<ScriptTask,ScriptTaskProperties>

Represents a task that executes shell script.

Field Summary

Fields inherited from class com.atlassian.bamboo.specs.api.builders.task.Task

conditions, description, requirements, taskEnabled

Constructor Summary

Constructors

Constructor	Description
ScriptTask()

Method Summary

Modifier and Type	Method	Description
ScriptTask	argument(@NotNull String argument)	Sets command line argument to be passed when script is executed.
protected @NotNull ScriptTaskProperties	build()
ScriptTask	environmentVariables(@NotNull String environmentVariables)	Sets environment variables to be set when script is executed.
boolean	equals(Object o)
ScriptTask	fileFromPath(@NotNull String path)	Sets the file path of script to execute.
ScriptTask	fileFromPath(@NotNull Path path)	Sets the file path of script to execute.
int	hashCode()
ScriptTask	inlineBody(@NotNull String body)	Sets body of the script to execute.
ScriptTask	inlineBodyFromPath(@NotNull Path path)	Sets body of the script to execute from a file.
ScriptTask	interpreter(ScriptTaskProperties.Interpreter interpreter)	Selects interpreter that will run the script.
ScriptTask	interpreterBinSh()	Specifies that script will be run by /bin/sh.
ScriptTask	interpreterCmdExe()	Selects that script should be run by cmd.exe.
ScriptTask	interpreterShell()	Specifies that script will be run by an interpreter chosen based on the shebang line of the script.
ScriptTask	interpreterWindowsPowerShell()	Specifies that script will be run by Windows PowerShell.
ScriptTask	location(ScriptTaskProperties.Location location)	Specifies the source of script to run.
String	toString()
ScriptTask	workingSubdirectory(@NotNull String workingSubdirectory)	Sets a directory the script should be executed in.

Methods inherited from class com.atlassian.bamboo.specs.api.builders.task.Task

conditions, description, enabled, requirements

Methods inherited from class java.lang.Object

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

Constructor Details

ScriptTask

public ScriptTask()

Method Details

location

public ScriptTask location(ScriptTaskProperties.Location location)

Specifies the source of script to run. Possible options are:

INLINE

task runs a script which is stored within this task's configuration

SCRIPT

task runs a script form an external file

interpreterShell

public ScriptTask interpreterShell()

Specifies that script will be run by an interpreter chosen based on the shebang line of the script.

See Also:

• interpreter(ScriptTaskProperties.Interpreter)

interpreterWindowsPowerShell

public ScriptTask interpreterWindowsPowerShell()

Specifies that script will be run by Windows PowerShell.

See Also:

• interpreter(ScriptTaskProperties.Interpreter)

interpreterBinSh

public ScriptTask interpreterBinSh()

Specifies that script will be run by /bin/sh.

See Also:

• interpreter(ScriptTaskProperties.Interpreter)

interpreterCmdExe

public ScriptTask interpreterCmdExe()

Selects that script should be run by cmd.exe.

See Also:

• interpreter(ScriptTaskProperties.Interpreter)

interpreter

public ScriptTask interpreter(ScriptTaskProperties.Interpreter interpreter)

Selects interpreter that will run the script. Possible choices are:

SHELL

script will be run by an interpreter chosen based on the shebang line of the script

WINDOWS_POWER_SHELL

script will be run by Windows PowerShell

BINSH_OR_CMDEXE

script will be run by /bin/sh or cmd.exe, depending on the operating system

inlineBody

public ScriptTask inlineBody(@NotNull
 @NotNull String body)

Sets body of the script to execute. Only valid when ScriptTaskProperties.Location.INLINE script location is selected.

inlineBodyFromPath

public ScriptTask inlineBodyFromPath(@NotNull
 @NotNull Path path)

Sets body of the script to execute from a file. Only valid when ScriptTaskProperties.Location.INLINE script location is selected.

Parameters:

path - path to the file with the script text

fileFromPath

public ScriptTask fileFromPath(@NotNull
 @NotNull Path path)

Sets the file path of script to execute. Only valid when ScriptTaskProperties.Location.FILE script location is selected.

fileFromPath

public ScriptTask fileFromPath(@NotNull
 @NotNull String path)

Sets the file path of script to execute. Only valid when ScriptTaskProperties.Location.FILE script location is selected.

argument

public ScriptTask argument(@NotNull
 @NotNull String argument)

Sets command line argument to be passed when script is executed.

environmentVariables

public ScriptTask environmentVariables(@NotNull
 @NotNull String environmentVariables)

Sets environment variables to be set when script is executed.

workingSubdirectory

public ScriptTask workingSubdirectory(@NotNull
 @NotNull String workingSubdirectory)

Sets a directory the script should be executed in.

build

@NotNull
protected @NotNull ScriptTaskProperties build()

Specified by:

build in class Task<ScriptTask,ScriptTaskProperties>

equals

public boolean equals(Object o)

Overrides:

equals in class Task<ScriptTask,ScriptTaskProperties>

hashCode

public int hashCode()

Overrides:

hashCode in class Task<ScriptTask,ScriptTaskProperties>

toString

public String toString()

Overrides:

toString in class Task<ScriptTask,ScriptTaskProperties>