Module io.helidon.scheduling

Package io.helidon.scheduling

Interface CronConfig

All Superinterfaces:

Prototype.Api, Prototype.Factory<Cron>, TaskConfig

All Known Implementing Classes:

CronConfig.BuilderBase.CronConfigImpl

public interface CronConfig
extends Prototype.Api, TaskConfig

Interface generated from blueprint io.helidon.scheduling.CronConfigBlueprint. 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	CronConfig.Builder	Fluent API builder for Cron.
static class	CronConfig.BuilderBase<BUILDER extends CronConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends CronConfig>	Fluent API builder base for CronConfig.

Method Summary

Modifier and Type	Method	Description
static CronConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static CronConfig.Builder	builder(CronConfig instance)	Create a new fluent API builder from an existing instance.
boolean	concurrentExecution()	Allow concurrent execution if previous task didn't finish before next execution.
static CronConfig	create(Config config)	Deprecated. use create(io.helidon.config.Config)
static CronConfig	create(Config config)	Create a new instance from configuration.
String	expression()	Cron expression for specifying period of execution.
ScheduledConsumer<CronInvocation>	task()	Task to be scheduled for execution.
ZoneId	zone()	Time zone to use for cron expression evaluation.

Methods inherited from interface io.helidon.builder.api.Prototype.Factory

build

Methods inherited from interface io.helidon.scheduling.TaskConfig

enabled, executor, id, taskManager

Method Details

builder

static CronConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static CronConfig.Builder builder(CronConfig 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 CronConfig 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 CronConfig create(Config config)

Deprecated.

use create(io.helidon.config.Config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

expression

String expression()

Cron expression for specifying period of execution.

Examples:

• 0/2 * * * * ? * - Every 2 seconds
• 0 45 9 ? * * - Every day at 9:45
• 0 15 8 ? * MON-FRI - Every workday at 8:15

Returns:

cron expression

zone

ZoneId zone()

Time zone to use for cron expression evaluation. Defaults to ZoneId.systemDefault().

The time zone determines when the cron expression triggers. For example, a cron expression 0 0 9 * * ? (every day at 9:00 AM) with zone America/New_York will trigger at 9:00 AM Eastern Time, regardless of the system's default time zone.

Returns:

time zone for cron expression evaluation

concurrentExecution

boolean concurrentExecution()

Allow concurrent execution if previous task didn't finish before next execution. Default value is true.

Returns:

true for allow concurrent execution.

task

ScheduledConsumer<CronInvocation> task()

Task to be scheduled for execution.

Returns:

scheduled for execution