Package io.quarkus.scheduler.runtime

Interface SchedulerConfig

@ConfigRoot(phase=BUILD_AND_RUN_TIME_FIXED) @ConfigMapping(prefix="quarkus.scheduler") public interface SchedulerConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    com.cronutils.model.CronType
    cronType()
    The syntax used in CRON expressions.
    boolean
    metricsEnabled()
    Scheduled task metrics will be enabled if a metrics extension is present and this value is true.
    boolean
    tracingEnabled()
    Controls whether tracing is enabled.
    boolean
    useCompositeScheduler()
    By default, only one Scheduler implementation is used.

  • Method Details

    • cronType

      @WithDefault("quartz") com.cronutils.model.CronType cronType()
      The syntax used in CRON expressions.
      See Also:
      • Scheduled.cron()

    • metricsEnabled

      @WithName("metrics.enabled") @WithDefault("false") boolean metricsEnabled()
      Scheduled task metrics will be enabled if a metrics extension is present and this value is true.

    • tracingEnabled

      @WithName("tracing.enabled") @WithDefault("false") boolean tracingEnabled()
      Controls whether tracing is enabled. If set to true and the OpenTelemetry extension is present, tracing will be enabled, creating automatic Spans for each scheduled task.

    • useCompositeScheduler

      @WithDefault("false") boolean useCompositeScheduler()
      By default, only one Scheduler implementation is used. If set to true then a composite Scheduler that delegates to all running implementations is used.

      Scheduler implementations will be started depending on the value of quarkus.scheduler.start-mode, i.e. the scheduler is not started unless a relevant Scheduled business method is found.