prefect.server.models.task_run_states
¶
Functions for interacting with task run state ORM objects. Intended for internal use by the Prefect REST API.
delete_task_run_state
async
¶
Delete a task run state by id.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session
|
Session
|
A database session |
required |
task_run_state_id
|
UUID
|
a task run state id |
required |
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
whether or not the task run state was deleted |
Source code in prefect/server/models/task_run_states.py
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
|
read_task_run_state
async
¶
Reads a task run state by id.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session
|
Session
|
A database session |
required |
task_run_state_id
|
UUID
|
a task run state id |
required |
Returns:
Type | Description |
---|---|
db.TaskRunState: the task state |
Source code in prefect/server/models/task_run_states.py
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
|
read_task_run_states
async
¶
Reads task runs states for a task run.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session
|
Session
|
A database session |
required |
task_run_id
|
UUID
|
the task run id |
required |
Returns:
Type | Description |
---|---|
List[db.TaskRunState]: the task run states |
Source code in prefect/server/models/task_run_states.py
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
|