Setuav Studio Developer Documentation 1.0
SDK and plugin development reference for Setuav Studio
Loading...
Searching...
No Matches
setuav_studio_sdk.tasks.TaskHandle Class Reference

Handle to a submitted background task. More...

Inherits Protocol, and T_co.

Collaboration diagram for setuav_studio_sdk.tasks.TaskHandle:

Public Member Functions

str id (self)
 Unique task identifier.
 
str name (self)
 Human-readable task name.
 
TaskPriority priority (self)
 Task priority.
 
TaskStatus status (self)
 Current lifecycle status.
 
bool is_cancelled (self)
 True if cancellation was requested.
 
float created_at (self)
 Epoch timestamp when the task was created.
 
float|None started_at (self)
 Epoch timestamp when the task started running.
 
float|None completed_at (self)
 Epoch timestamp when the task finished/failed/cancelled.
 
float duration_seconds (self)
 Total execution duration in seconds.
 
TaskProgress|None progress (self)
 Current progress snapshot.
 
Any|None result (self)
 Result returned by successful task execution.
 
Exception|None error (self)
 Exception raised during task execution, if any.
 
bool cancel (self)
 Request cancellation.
 

Detailed Description

Handle to a submitted background task.