TaskDefinition (Atlassian Bamboo 9.6.4 API)

All Superinterfaces:

EntityWithOid, ImmutableEntityWithOid, PluginKeyProvider, Serializable, TaskIdentifier

All Known Subinterfaces:

DecoratedTaskDefinition<T>, RuntimeTaskDefinition

All Known Implementing Classes:

DecoratedTaskDefinitionImpl, ImmutableTaskDefinition, RuntimeTaskDefinitionImpl, TaskDefinitionImpl
```
@PublicApi
public interface TaskDefinition
extends TaskIdentifier, EntityWithOid, Serializable
```
A definition of one configuration of a TaskType

Since:

3.1

See Also:

TaskConfigurator

Field Summary

Fields
Modifier and Type Field Description

static boolean DISABLED

static boolean ENABLED

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`@NotNull List<TaskConditionConfig>`	`getConditions()`
`@NotNull Map<String,String>`	`getConfiguration()`	Represents the raw configuration data for this configuration.
`default BambooEntityType`	`getEntityType()`	Entity type of this object, used in `BambooEntityOid`.
`@NotNull TaskRootDirectorySelector`	`getRootDirectorySelector()`
`void`	`setConditions(@NotNull List<TaskConditionConfig> conditions)`
`void`	`setConfiguration(@NotNull Map<String,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(@NotNull TaskRootDirectorySelector taskRootDirectorySelector)`
`void`	`setUserDescription(@Nullable String userDescription)`

Methods inherited from interface com.atlassian.bamboo.core.EntityWithOid
setOid

Methods inherited from interface com.atlassian.bamboo.core.ImmutableEntityWithOid
getOid

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
                        @Nullable 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
@NotNull TaskRootDirectorySelector getRootDirectorySelector()
```
Returns:

data defining tasks' root directory

Since:

3.3

setRootDirectorySelector

void setRootDirectorySelector(@NotNull
                              @NotNull TaskRootDirectorySelector taskRootDirectorySelector)

Parameters:: taskRootDirectorySelector -
Since:: 3.3

getConfiguration
```
@NotNull
@NotNull Map<String,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
                      @NotNull Map<String,String> configuration)

getEntityType
```
default BambooEntityType getEntityType()
```
Description copied from interface: ImmutableEntityWithOid

Entity type of this object, used in BambooEntityOid.

Specified by:

getEntityType in interface ImmutableEntityWithOid

getConditions
```
@NotNull
@NotNull List<TaskConditionConfig> getConditions()
```
Returns:

task conditions. UI supports only one condition per task.

setConditions

void setConditions(@NotNull
                   @NotNull List<TaskConditionConfig> conditions)