Kronos/kronos/schedulePeriodic

schedulePeriodic

suspend fun Kronos.schedulePeriodic(jobName: String, delay: <Error class: unknown class> = Duration.ZERO, periodic: Periodic, endTime: Long? = null, maxCycles: Int? = null, retries: Int? = null, params: Map<String, String>, overshotAction: OvershotAction = OvershotAction.Drop): String?

Parameters

jobName

The unique name of a job that has already been registered

delay

This would influence the start time of the periodic task

periodic

Specify tight constraints on the frequency and interval of execution. Take a look at Periodic.Companion.everyDay

endTime

The job wil not be repeated if it is after this time

maxCycles

The job wil not be repeated after this number of cycles

retries

The number of retries if the job execution fails. Falls back to the Job.retries of the Job if not specified

params

The data that will be made available to your job during execution. Note that 'cycleNumber' is a reserved name and should not be included

overshotAction

What do you want to happen when the job runner finds that the job start time is in the past. This can happen when the job does no run at the start time because the system is down or was not handled by the job runner

suspend fun Kronos.schedulePeriodic(jobName: String, startTime: Long, periodic: Periodic, endTime: Long? = null, maxCycles: Int? = null, retries: Int? = null, params: Map<String, String>, overshotAction: OvershotAction = OvershotAction.Drop): String?