Interface TaskConfig

All Superinterfaces:
Prototype.Api
All Known Subinterfaces:
CronConfig, FixedRateConfig
All Known Implementing Classes:
CronConfig.BuilderBase.CronConfigImpl, FixedRateConfig.BuilderBase.FixedRateConfigImpl, TaskConfig.BuilderBase.TaskConfigImpl

public interface TaskConfig extends Prototype.Api
Interface generated from definition. Please add javadoc to the definition interface.
See Also:
  • Method Details

    • builder

      static TaskConfig.Builder builder()
      Create a new fluent API builder to customize configuration.
      Returns:
      a new builder
    • builder

      static TaskConfig.Builder builder(TaskConfig instance)
      Create a new fluent API builder from an existing instance.
      Parameters:
      instance - an existing instance used as a base for the builder
      Returns:
      a builder based on an instance
    • create

      static TaskConfig create(Config config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration
    • create

      @Deprecated static TaskConfig create(Config config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration
    • create

      static TaskConfig create()
      Create a new instance with default values.
      Returns:
      a new instance
    • executor

      Custom ScheduledExecutorService used for executing scheduled task.
      Returns:
      custom ScheduledExecutorService
    • taskManager

      TaskManager taskManager()
      Task manager that will manage the created task.
      Returns:
      task manager, by default taken from the global service registry
    • id

      Identification of the started task. This can be used to later look up the instance, for example to cancel it.
      Returns:
      task id, if not provided via configuration or builder, the configured task will generate a unique ID