Documentation Index Fetch the complete documentation index at: https://docs.prefect.io/llms.txt
Use this file to discover all available pages before exploring further.
prefect.server.api.task_runsRoutes for interacting with task run objects.
Functions create_task_run create_task_run(task_run: schemas.actions.TaskRunCreate, response: Response, db: PrefectDBInterface = Depends(provide_database_interface), orchestration_parameters: Dict[ str , Any] = Depends(orchestration_dependencies.provide_task_orchestration_parameters)) -> schemas.core.TaskRun
Create a task run. If a task run with the same flow_run_id,
task_key, and dynamic_key already exists, the existing task
run will be returned.
If no state is provided, the task run will be created in a PENDING state.
For more information, see https://docs.prefect.io/v3/concepts/tasks .
update_task_run update_task_run(task_run: schemas.actions.TaskRunUpdate, task_run_id: UUID = Path( ... , description = 'The task run id' , alias = 'id' ), db: PrefectDBInterface = Depends(provide_database_interface)) -> None
Updates a task run.
count_task_runs count_task_runs(db: PrefectDBInterface = Depends(provide_database_interface), flows: schemas.filters.FlowFilter = None , flow_runs: schemas.filters.FlowRunFilter = None , task_runs: schemas.filters.TaskRunFilter = None , deployments: schemas.filters.DeploymentFilter = None ) -> int
Count task runs.
task_run_history task_run_history(history_start: DateTime = Body( ... , description = "The history's start time." ), history_end: DateTime = Body( ... , description = "The history's end time." ), history_interval_seconds: float = Body( ... , description = 'The size of each history interval, in seconds. Must be at least 1 second.' , json_schema_extra = { 'format' : 'time-delta' }), flows: schemas.filters.FlowFilter = None , flow_runs: schemas.filters.FlowRunFilter = None , task_runs: schemas.filters.TaskRunFilter = None , deployments: schemas.filters.DeploymentFilter = None , db: PrefectDBInterface = Depends(provide_database_interface)) -> List[schemas.responses.HistoryResponse]
Query for task run history data across a given range and interval.
read_task_run read_task_run(task_run_id: UUID = Path( ... , description = 'The task run id' , alias = 'id' ), db: PrefectDBInterface = Depends(provide_database_interface)) -> schemas.core.TaskRun
Get a task run by id.
read_task_runs read_task_runs(sort: schemas.sorting.TaskRunSort = Body(schemas.sorting.TaskRunSort. ID_DESC ), limit: int = dependencies.LimitBody(), offset: int = Body( 0 , ge = 0 ), flows: Optional[schemas.filters.FlowFilter] = None , flow_runs: Optional[schemas.filters.FlowRunFilter] = None , task_runs: Optional[schemas.filters.TaskRunFilter] = None , deployments: Optional[schemas.filters.DeploymentFilter] = None , db: PrefectDBInterface = Depends(provide_database_interface)) -> List[schemas.core.TaskRun]
Query for task runs.
paginate_task_runs paginate_task_runs(sort: schemas.sorting.TaskRunSort = Body(schemas.sorting.TaskRunSort. ID_DESC ), limit: int = dependencies.LimitBody(), page: int = Body( 1 , ge = 1 ), flows: Optional[schemas.filters.FlowFilter] = None , flow_runs: Optional[schemas.filters.FlowRunFilter] = None , task_runs: Optional[schemas.filters.TaskRunFilter] = None , deployments: Optional[schemas.filters.DeploymentFilter] = None , db: PrefectDBInterface = Depends(provide_database_interface)) -> TaskRunPaginationResponse
Pagination query for task runs.
delete_task_run delete_task_run(docket: dependencies.Docket, task_run_id: UUID = Path( ... , description = 'The task run id' , alias = 'id' ), db: PrefectDBInterface = Depends(provide_database_interface)) -> None
Delete a task run by id.
delete_task_run_logs delete_task_run_logs() -> None
set_task_run_state set_task_run_state(task_run_id: UUID = Path( ... , description = 'The task run id' , alias = 'id' ), state: schemas.actions.StateCreate = Body( ... , description = 'The intended state.' ), force: bool = Body( False , description = 'If false, orchestration rules will be applied that may alter or prevent the state transition. If True, orchestration rules are not applied.' ), db: PrefectDBInterface = Depends(provide_database_interface), response: Response = None , task_policy: TaskRunOrchestrationPolicy = Depends(orchestration_dependencies.provide_task_policy), orchestration_parameters: Dict[ str , Any] = Depends(orchestration_dependencies.provide_task_orchestration_parameters)) -> OrchestrationResult
Set a task run state, invoking any orchestration rules.
scheduled_task_subscription scheduled_task_subscription(websocket: WebSocket) -> None
