Kronos/kronos/Job

Job

interface Job

Kronos Job For Scheduling tasks

Properties

name

abstract val name: String

The Job Name. this should be unique

retries

open val retries: Int

The number of times the job should be retired, overridden by 'retries' in Kronos.schedulePeriodic

Functions

challengeRun

open fun challengeRun(cycleNumber: Int, params: Map<String, Any>): Boolean

Custom pre-run gate called after Kronos's own scheduling validation. Return true to skip this cycle; return false (default) to allow execution.

execute

open suspend fun execute(cycleNumber: Int, params: Map<String, Any>): Boolean

execute task for job, return true if job was successful

onDrop

open fun onDrop(jobId: String, lastJob: Boolean)

Called each time a job record is removed from the database. lastJob is true when no further jobs with this name remain.

onFail

open fun onFail(cycleNumber: Int, params: Map<String, Any>, exception: Exception?)

Called once after all retries are exhausted and the job has still not succeeded.

onLasCycleDrop

open fun onLasCycleDrop(jobId: String, params: Map<String, Any>)

Called when the final cycle of a bounded job (maxCycles or endTime) completes and the job is dropped.

onRetryFail

open fun onRetryFail(retryCount: Int, cycleNumber: Int, params: Map<String, Any>, exception: Exception?)

Called after each individual retry attempt fails. retryCount goes from 1 to retries. onFail is called once all retries are exhausted.

onSuccess

open fun onSuccess(cycleNumber: Int, params: Map<String, Any>)

Called when execute returns true.

periodicJobLoaded

open fun periodicJobLoaded(originJobId: String, nextJobId: String)

Called when the next occurrence of a repeating job has been inserted into the database. Useful for tracking the current job ID when you hold a reference to it.