blob: 54dd85b08981c717167c90ce8a478c782f8a051a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
:mod:`apscheduler.events`
============================
.. automodule:: apscheduler.events
API
---
.. autoclass:: SchedulerEvent
:members:
.. autoclass:: JobEvent
:members:
:show-inheritance:
.. autoclass:: JobSubmissionEvent
:members:
:show-inheritance:
.. autoclass:: JobExecutionEvent
:members:
:show-inheritance:
Event codes
-----------
The following event codes are numeric constants importable from :mod:`apscheduler.events`.
.. list-table::
:header-rows: 1
* - Constant
- Description
- Event class
* - EVENT_SCHEDULER_STARTED
- The scheduler was started
- :class:`SchedulerEvent`
* - EVENT_SCHEDULER_SHUTDOWN
- The scheduler was shut down
- :class:`SchedulerEvent`
* - EVENT_SCHEDULER_PAUSED
- Job processing in the scheduler was paused
- :class:`SchedulerEvent`
* - EVENT_SCHEDULER_RESUMED
- Job processing in the scheduler was resumed
- :class:`SchedulerEvent`
* - EVENT_EXECUTOR_ADDED
- An executor was added to the scheduler
- :class:`SchedulerEvent`
* - EVENT_EXECUTOR_REMOVED
- An executor was removed to the scheduler
- :class:`SchedulerEvent`
* - EVENT_JOBSTORE_ADDED
- A job store was added to the scheduler
- :class:`SchedulerEvent`
* - EVENT_JOBSTORE_REMOVED
- A job store was removed from the scheduler
- :class:`SchedulerEvent`
* - EVENT_ALL_JOBS_REMOVED
- All jobs were removed from either all job stores or one particular job store
- :class:`SchedulerEvent`
* - EVENT_JOB_ADDED
- A job was added to a job store
- :class:`JobEvent`
* - EVENT_JOB_REMOVED
- A job was removed from a job store
- :class:`JobEvent`
* - EVENT_JOB_MODIFIED
- A job was modified from outside the scheduler
- :class:`JobEvent`
* - EVENT_JOB_SUBMITTED
- A job was submitted to its executor to be run
- :class:`JobSubmissionEvent`
* - EVENT_JOB_MAX_INSTANCES
- A job being submitted to its executor was not accepted by the executor because the job has
already reached its maximum concurrently executing instances
- :class:`JobSubmissionEvent`
* - EVENT_JOB_EXECUTED
- A job was executed successfully
- :class:`JobExecutionEvent`
* - EVENT_JOB_ERROR
- A job raised an exception during execution
- :class:`JobExecutionEvent`
* - EVENT_JOB_MISSED
- A job's execution was missed
- :class:`JobExecutionEvent`
* - EVENT_ALL
- A catch-all mask that includes every event type
- N/A
|
