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 blueprint io.helidon.scheduling.TaskConfigBlueprint. Please add javadoc to blueprint, as it is currently missing.

See Also:

• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TaskConfig.Builder	Fluent API builder for TaskConfig.
static class	TaskConfig.BuilderBase<BUILDER extends TaskConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends TaskConfig>	Fluent API builder base for TaskConfig.

Method Summary

Modifier and Type	Method	Description
static TaskConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static TaskConfig.Builder	builder(TaskConfig instance)	Create a new fluent API builder from an existing instance.
static TaskConfig	create()	Create a new instance with default values.
static TaskConfig	create(Config config)	Create a new instance from configuration.
boolean	enabled()	Whether the task is enabled.
ScheduledExecutorService	executor()	Custom ScheduledExecutorService used for executing scheduled task.
Optional<String>	id()	Identification of the started task.
TaskManager	taskManager()	Task manager that will manage the created task.

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

static TaskConfig create()

Create a new instance with default values.

Returns:

a new instance

executor

ScheduledExecutorService 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

Optional<String> 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

enabled

boolean enabled()

Whether the task is enabled. If disabled, the task will not be scheduled. Default value is true.

Returns:

true if the task should be scheduled