io.micronaut.scheduling.annotation

Annotation Type Scheduled

@Documented
 @Retention(value=RUNTIME)
 @Target(value={METHOD,ANNOTATION_TYPE})
 @Executable(processOnStartup=true)
 @Repeatable(value=Schedules.class)
 @Parallel
public @interface Scheduled

An annotation for scheduling a re-occurring task.

Since:

1.0

Author:

graemerocher

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	cron
String	fixedDelay A String representation of the Duration between the time of the last execution and the beginning of the next.
String	fixedRate A String representation of the Duration between executions.
String	initialDelay A String representation of the Duration before starting executions.
String	scheduler
String	zoneId A String representation of the ZoneId to base our cron expression on.

Element Detail

cron

public abstract String cron

Returns:

The CRON expression

Default:

""

zoneId

public abstract String zoneId

A String representation of the ZoneId to base our cron expression on. Defaults to ZoneId.systemDefault()

Returns:

The ZoneId to base the cron expression on

Default:

""

fixedDelay

public abstract String fixedDelay

A String representation of the Duration between the time of the last execution and the beginning of the next. For example 10m == 10 minutes

Returns:

The fixed delay

Default:

""

initialDelay

public abstract String initialDelay

A String representation of the Duration before starting executions. For example 10m == 10 minutes

Returns:

The fixed delay

Default:

""

fixedRate

public abstract String fixedRate

A String representation of the Duration between executions. For example 10m == 10 minutes

Returns:

The fixed rate

Default:

""

scheduler

public abstract String scheduler

Returns:

The name of a Named bean that is a ScheduledExecutorService to use to schedule the task

Default:

"scheduled"