TaskResultService#
- class TaskResultService[source]#
- get_all(*, offset=0, limit=50)[source]#
Get all active tasks, all tasks that have not yet been started, a page of finished tasks, and the total number of finished tasks.
- Parameters:
offset (
int) – First finished task to get.limit (
int) – Amount of finished tasks to get.self (TaskResultService[AuthenticatedClient]) –
- Returns:
The requested tasks, with the given limits applied to the finished jobs.
- Return type:
- get(*, task_result_id)[source]#
Get the state of a task result.
To check if the task failed you should use the state attribute of the returned object as the status code of the response will still be 200. It is 200 as we successfully fulfilled the request, which was getting the task result.
- Parameters:
task_result_id (
str) – The task result to get.self (TaskResultService[AuthenticatedClient]) –
- Returns:
The retrieved task result.
- Return type:
- restart(*, task_result_id)[source]#
Restart a task result.
The restarted task must not be in the not_started, started, or finished state.
- Parameters:
task_result_id (
str) – The task result to restart.self (TaskResultService[AuthenticatedClient]) –
- Returns:
Nothing.
- Return type:
None
- revoke(*, task_result_id)[source]#
Revoke a task result.
The revoked task must be in the “not_started” state.
- Parameters:
task_result_id (
str) – The task result to revoke.self (TaskResultService[AuthenticatedClient]) –
- Returns:
Nothing.
- Return type:
None