Oban.cancel_job
You're seeing just the function
cancel_job
, go back to Oban module for more information.
Specs
cancel_job(name(), job_id :: pos_integer()) :: :ok
Cancel an available
, scheduled
or retryable
job and mark it as discarded
to prevent it
from running. If the job is currently executing
it will be killed and otherwise it is ignored.
If an executing job happens to fail before it can be cancelled the state is set to discarded
.
However, if it manages to complete successfully then the state will still be completed
.
Example
Cancel a scheduled job with the id 1
:
Oban.cancel_job(1)
:ok