File: events.rst

package info (click to toggle)
python-ewoksutils 0.1.1-5
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 220 kB
  • sloc: python: 622; makefile: 2
file content (44 lines) | stat: -rw-r--r-- 4,157 bytes parent folder | download
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
Workflow events
===============

Events are emitted when executing a workflow. The event fields are

+------------------+-------------------+------------------------+-------------------------------------+
| Field            | Type              | Not None when          | Value                               |
+==================+===================+========================+=====================================+
| host_name        | str               |                        |                                     |
+------------------+-------------------+------------------------+-------------------------------------+
| process_id       | int               |                        |                                     |
+------------------+-------------------+------------------------+-------------------------------------+
| user_name        | str               |                        |                                     |
+------------------+-------------------+------------------------+-------------------------------------+
| job_id           | str               |                        | random uuid by default              |
+------------------+-------------------+------------------------+-------------------------------------+
| binding          | str\|None         | scheduler when used    |                                     |
+------------------+-------------------+------------------------+-------------------------------------+
| context          | str               |                        | `"job"`, `"workflow"` or `"node"`   |
+------------------+-------------------+------------------------+-------------------------------------+
| workflow_id      | str               |                        |                                     |
+------------------+-------------------+------------------------+-------------------------------------+
| node_id          | str\|None         | `context == "node"`    |                                     |
+------------------+-------------------+------------------------+-------------------------------------+
| task_id          | str\|None         | `context == "node"`    |                                     |
+------------------+-------------------+------------------------+-------------------------------------+
| type             | str               |                        | `"start"`, `"end"` or `"progress"`  |
+------------------+-------------------+------------------------+-------------------------------------+
| time             | str               |                        | ISO 8601 format in local timezone   |
+------------------+-------------------+------------------------+-------------------------------------+
| error            | bool\|None        | `event == "end"`       |                                     |
+------------------+-------------------+------------------------+-------------------------------------+
| error_message    | str\|None         | `event == "end"`       |                                     |
+------------------+-------------------+------------------------+-------------------------------------+
| error_traceback  | str\|None         | `event == "end"`       |                                     |
+------------------+-------------------+------------------------+-------------------------------------+
| progress         | int\|None         | `event == "progress"`  | number between 0 and 100            |
+------------------+-------------------+------------------------+-------------------------------------+
| task_uri         | str\|None         |                        |                                     |
+------------------+-------------------+------------------------+-------------------------------------+
| input_uris       | List[Dict]\|None  | `event == "start"`     |                                     |
+------------------+-------------------+------------------------+-------------------------------------+
| output_uris      | List[Dict]\|None  | `event == "start"`     |                                     |
+------------------+-------------------+------------------------+-------------------------------------+