io.quarkus.scheduler

Annotation Type Scheduled

@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Repeatable(value=Scheduled.Schedules.class)
public @interface Scheduled

Marks a business method to be automatically scheduled and invoked by the container.

The schedule is defined either by cron() or by every() attribute. If both are specified, the cron expression takes precedence.

 @ApplicationScoped
 class MyService {

     @Scheduled(cron = "0/5 * * * * ?")
     void check() {
         // do something important every 5 seconds
     }
 }
 

The annotated method must return void and either declare no parameters or one parameter of type ScheduledExecution.

Author:

Martin Kouba

See Also:

ScheduledExecution

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Scheduled.ConcurrentExecution	concurrentExecution Specify the strategy to handle concurrent execution of a scheduled method.
String	cron Defines a cron-like expression.
long	delay Delays the time the trigger should start at.
String	delayed Defines a period after which the trigger should start.
TimeUnit	delayUnit
String	every Defines a period between invocations.
String	identity Optionally defines a unique identifier for this job.

Element Detail

identity

public abstract String identity

Optionally defines a unique identifier for this job.

If the value is not given, Quarkus will generate a unique id.

Returns:

the unique identity of the schedule

Default:

""

cron

public abstract String cron

Defines a cron-like expression. For example "0 15 10 * * ?" fires at 10:15am every day.

If the value starts with "{" and ends with "}" the scheduler attempts to find a corresponding config property and use the configured value instead: @Scheduled(cron = "{myservice.check.cron.expr}").

Returns:

the cron-like expression

Default:

""

every

public abstract String every

Defines a period between invocations.

The value is parsed with Duration.parse(CharSequence). However, if an expression starts with a digit, "PT" prefix is added automatically, so for example, 15m can be used instead of PT15M and is parsed as "15 minutes". Note that the absolute value of the value is always used.

If the value starts with "{" and ends with "}" the scheduler attempts to find a corresponding config property and use the configured value instead: @Scheduled(every = "{myservice.check.every.expr}").

Returns:

the period expression based on the ISO-8601 duration format PnDTnHnMn.nS

Default:

""

delay

public abstract long delay

Delays the time the trigger should start at. The value is rounded to full second.

By default, the trigger starts when registered.

Returns:

the initial delay

Default:

0L

delayUnit

public abstract TimeUnit delayUnit

Returns:

the unit of initial delay

See Also:

delay()

Default:

java.util.concurrent.TimeUnit.MINUTES

delayed

public abstract String delayed

Defines a period after which the trigger should start. It's an alternative to delay(). If delay() is set to a value greater then zero the value of delayed() is ignored.

The value is parsed with Duration.parse(CharSequence). However, if an expression starts with a digit, "PT" prefix is added automatically, so for example, 15s can be used instead of PT15S and is parsed as "15 seconds". Note that the absolute value of the value is always used.

If the value starts with "{" and ends with "}" the scheduler attempts to find a corresponding config property and use the configured value instead: @Scheduled(delayed = "{myservice.delayed}").

Returns:

the period expression based on the ISO-8601 duration format PnDTnHnMn.nS

Default:

""

concurrentExecution

public abstract Scheduled.ConcurrentExecution concurrentExecution

Specify the strategy to handle concurrent execution of a scheduled method. By default, a scheduled method can be executed concurrently.

Returns:

the concurrent execution strategy

Default:

io.quarkus.scheduler.Scheduled.ConcurrentExecution.PROCEED