com.atlassian.bamboo.task
Interface TaskDefinition

All Superinterfaces:

java.io.Serializable, TaskIdentifier

All Known Implementing Classes:

DecoratedTaskDefinition, ImmutableTaskDefinition, TaskDefinitionImpl

@PublicApi
public interface TaskDefinition
extends TaskIdentifier, java.io.Serializable

A definition of one configuration of a TaskType

Since:

3.1

See Also:

TaskConfigurator

Field Summary

static boolean	DISABLED
static boolean	ENABLED

Method Summary

java.util.Map<java.lang.String,java.lang.String>	getConfiguration() Represents the raw configuration data for this configuration.
TaskRootDirectorySelector	getRootDirectorySelector()
void	setConfiguration(java.util.Map<java.lang.String,java.lang.String> configuration)
void	setEnabled(boolean isEnabled) Tells bamboo whether this task should run as a part of this build or not.
void	setFinalising(boolean finalising)
void	setRootDirectorySelector(TaskRootDirectorySelector taskRootDirectorySelector)
void	setUserDescription(java.lang.String userDescription)

Methods inherited from interface com.atlassian.bamboo.task.TaskIdentifier

getId, getPluginKey, getUserDescription, isEnabled, isFinalising

Field Detail

ENABLED

static final boolean ENABLED

See Also:

Constant Field Values

DISABLED

static final boolean DISABLED

See Also:

Constant Field Values

Method Detail

setUserDescription

void setUserDescription(@Nullable
                        java.lang.String userDescription)

setEnabled

void setEnabled(boolean isEnabled)

Tells bamboo whether this task should run as a part of this build or not.

Since:

4.4

setFinalising

void setFinalising(boolean finalising)

getRootDirectorySelector

@NotNull
TaskRootDirectorySelector getRootDirectorySelector()

Returns:

data defining tasks' root directory

Since:

3.3

setRootDirectorySelector

void setRootDirectorySelector(@NotNull
                              TaskRootDirectorySelector taskRootDirectorySelector)

Parameters:

taskRootDirectorySelector -

Since:

3.3

getConfiguration

@NotNull
java.util.Map<java.lang.String,java.lang.String> getConfiguration()

Represents the raw configuration data for this configuration. No variables are substituted.

Returns:

the plugin defined configuration for this task

setConfiguration

void setConfiguration(@NotNull
                      java.util.Map<java.lang.String,java.lang.String> configuration)