Skip to content

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

Entity saved.

export

Export object as a YAML file in the context folder.

Returns:

Type Description
str

Exported filepath.

refresh

Refresh object from backend.

Returns:

Type Description
ContextEntity

Entity refreshed.

Manage runs

run

Run task.

Parameters:

Name Type Description Default
run_kind str

Kind the object.

required
**kwargs dict

Keyword arguments.

{}

Returns:

Type Description
Run

Run object.

new_run

Create a new run.

Parameters:

Name Type Description Default
save bool

Flag to indicate save.

True
**kwargs dict

Keyword arguments to build run. See new_run().

{}

Returns:

Type Description
Run

Run object.

get_run

Get run.

Parameters:

Name Type Description Default
entity_key str

Entity key.

required

Returns:

Type Description
Run

Run object.

delete_run

Delete run.

Parameters:

Name Type Description Default
entity_key str

Entity key.

required

Returns:

Type Description
dict

Response from backend.

Task kinds

Task kinds are provided by runtimes. See the runtime documentation for the corresponding runtime behavior.