Package com.thoughtworks.go.plugin.api.task

Interface Task

@Deprecated public interface Task
Deprecated.
Task interface is the starting point for the task plugin.

  • Method Summary

    Modifier and Type
    Method
    Description
    TaskConfig
    config()
    Deprecated.
    Specifies the configuration accepted and expected for the task.
    TaskExecutor
    executor()
    Deprecated.
    The executor is the part of the plugin which actually does the work.
    ValidationResult
    validate(TaskConfig configuration)
    Deprecated.
    Checks if a given task configuration is valid.
    TaskView
    view()
    Deprecated.
    The implementation of TaskView returned by this method defines the view of the plugin, both in the task type dropdown of the job configuration UI as well as the modal box for the task.

  • Method Details

    • config

      TaskConfig config()
      Deprecated.
      Specifies the configuration accepted and expected for the task. It has a list of configuration properties (keys), with an optional default value each.
      Returns:
      an instance of TaskConfig

    • executor

      TaskExecutor executor()
      Deprecated.
      The executor is the part of the plugin which actually does the work. It is an interface which has a method, which will be called by the plugin infrastructure, with enough information about the configuration and environment, when the task needs to be run.
      Returns:
      an implementation of TaskExecutor

    • view

      TaskView view()
      Deprecated.
      The implementation of TaskView returned by this method defines the view of the plugin, both in the task type dropdown of the job configuration UI as well as the modal box for the task.
      Returns:
      an implementation of TaskView

    • validate

      ValidationResult validate(TaskConfig configuration)
      Deprecated.
      Checks if a given task configuration is valid. This is called during the "Save" action of the task configuration UI, and not during the configuration XML save.
      Parameters:
      configuration - Task configuration which needs to be validated.
      Returns:
      an instance of ValidationResult, which has any errors that need to be shown on the UI. The key against which the error is created should be the same as the one in the configuration.