Package io.quarkus.scheduler
Interface Scheduler.JobDefinition
-
- Enclosing interface:
- Scheduler
public static interface Scheduler.JobDefinitionThe job definition is a builder-like API that can be used to define a job programmatically.No job is scheduled until the
setTask(Consumer)orsetAsyncTask(Function)method is called.The implementation is not thread-safe and should not be reused.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Triggerschedule()Attempts to schedule the job.Scheduler.JobDefinitionsetAsyncTask(Function<ScheduledExecution,io.smallrye.mutiny.Uni<Void>> asyncTask)Scheduler.JobDefinitionsetConcurrentExecution(Scheduled.ConcurrentExecution concurrentExecution)Scheduler.JobDefinitionsetCron(String cron)The schedule is defined either bysetCron(String)or bysetInterval(String).Scheduler.JobDefinitionsetDelayed(String period)Scheduler.JobDefinitionsetInterval(String every)The schedule is defined either bysetCron(String)or bysetInterval(String).Scheduler.JobDefinitionsetOverdueGracePeriod(String period)Scheduler.JobDefinitionsetSkipPredicate(Scheduled.SkipPredicate skipPredicate)Scheduler.JobDefinitionsetTask(Consumer<ScheduledExecution> task)Scheduler.JobDefinitionsetTimeZone(String timeZone)
-
-
-
Method Detail
-
setCron
Scheduler.JobDefinition setCron(String cron)
The schedule is defined either bysetCron(String)or bysetInterval(String). If both methods are used, then the cron expression takes precedence.- Parameters:
cron-- Returns:
- self
- See Also:
Scheduled.cron()
-
setInterval
Scheduler.JobDefinition setInterval(String every)
The schedule is defined either bysetCron(String)or bysetInterval(String). If both methods are used, then the cron expression takes precedence.- Parameters:
every-- Returns:
- self
- See Also:
Scheduled.every()
-
setDelayed
Scheduler.JobDefinition setDelayed(String period)
- Parameters:
period-- Returns:
- self
- See Also:
Scheduled.delayed()
-
setConcurrentExecution
Scheduler.JobDefinition setConcurrentExecution(Scheduled.ConcurrentExecution concurrentExecution)
- Parameters:
concurrentExecution-- Returns:
- self
- See Also:
Scheduled.concurrentExecution()
-
setSkipPredicate
Scheduler.JobDefinition setSkipPredicate(Scheduled.SkipPredicate skipPredicate)
- Parameters:
skipPredicate-- Returns:
- self
- See Also:
Scheduled.skipExecutionIf()
-
setOverdueGracePeriod
Scheduler.JobDefinition setOverdueGracePeriod(String period)
- Parameters:
period-- Returns:
- self
- See Also:
Scheduled.overdueGracePeriod()
-
setTimeZone
Scheduler.JobDefinition setTimeZone(String timeZone)
- Returns:
- self
- See Also:
Scheduled.timeZone()
-
setTask
Scheduler.JobDefinition setTask(Consumer<ScheduledExecution> task)
- Parameters:
task-- Returns:
- self
-
setAsyncTask
Scheduler.JobDefinition setAsyncTask(Function<ScheduledExecution,io.smallrye.mutiny.Uni<Void>> asyncTask)
- Parameters:
asyncTask-- Returns:
- self
-
schedule
Trigger schedule()
Attempts to schedule the job.- Returns:
- the trigger
-
-