Use a task
The Task object provides CRUD methods and methods for managing its runs.
Persist and refresh
save
Save the entity into the backend.
Returns:
| Type |
Description |
ContextEntity
|
|
export
Export object as a YAML file in the context folder.
Returns:
refresh
Refresh object from backend.
Returns:
| Type |
Description |
ContextEntity
|
|
Manage runs
run
Run task.
Parameters:
| Name |
Type |
Description |
Default |
run_kind
|
str
|
|
required
|
**kwargs
|
dict
|
|
{}
|
Returns:
new_run
Create a new run.
Parameters:
| Name |
Type |
Description |
Default |
save
|
bool
|
|
True
|
**kwargs
|
dict
|
Keyword arguments to build run. See new_run().
|
{}
|
Returns:
get_run
Get run.
Parameters:
| Name |
Type |
Description |
Default |
entity_key
|
str
|
|
required
|
Returns:
delete_run
Delete run.
Parameters:
| Name |
Type |
Description |
Default |
entity_key
|
str
|
|
required
|
Returns:
Task kinds
Task kinds are provided by runtimes. See the runtime documentation for the corresponding runtime behavior.