Package com.atlassian.bamboo.task

Interface TaskIdentifier

All Superinterfaces:
PluginKeyProvider
All Known Subinterfaces:
CommonTaskContext, DecoratedTaskDefinition<T>, DeploymentTaskContext, InternalTaskContext, RuntimeTaskDefinition, TaskContext, TaskDefinition
All Known Implementing Classes:
CommonTaskContextImpl, DecoratedTaskDefinitionImpl, DeploymentTaskContextImpl, ImmutableTaskDefinition, RuntimeTaskDefinitionImpl, TaskContextImpl, TaskDefinitionImpl
@PublicApi public interface TaskIdentifier extends PluginKeyProvider
This interface defines a configured instance of a TaskType
Since:
3.1
See Also:

  • Method Details

    • getId

      long getId()
      Returns:
      the id of this configuration. Unique within the given context (e.g. Job

    • getPluginKey

      @NotNull @NotNull String getPluginKey()
      Specified by:
      getPluginKey in interface PluginKeyProvider
      Returns:
      Complete key of the task type plugin module

    • getUserDescription

      @Nullable @Nullable String getUserDescription()
      Returns:
      the description of the task as defined by the user

    • isEnabled

      boolean isEnabled()
      Returns:
      whether the task is enabled or disabled

    • isFinalising

      boolean isFinalising()
      Returns:
      true if the task should be run in finalisation phase