Run object
The Run object comes with three sets of methods: CRUD methods, generic run methods and (eventual) kind specific methods.
CRUD methods
Crud methods are used to interact with the entity object in the backend or locally.
save(): Save or update the entity into the backend.export(): Export the entity locally as yaml file.refresh(): Refresh (read) the entity from the backend.
save
Save or update the entity into the backend.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
update
|
bool
|
Flag to indicate update. |
False
|
Returns:
| Type | Description |
|---|---|
ContextEntity
|
Entity saved. |
export
Export object as a YAML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filename
|
str
|
Name of the export YAML file. If not specified, the default value is used. |
None
|
Returns:
| Type | Description |
|---|---|
str
|
Exported file. |
refresh
Refresh object from backend.
Returns:
| Type | Description |
|---|---|
ContextEntity
|
Entity refreshed. |
Run methods
There are several generic run methods on the Run object.
wait: Wait for the run to finish.stop: Stop the run.resume: Resume the run.
wait
Wait for run to finish.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
log_info
|
bool
|
If True, log information. |
True
|
Returns:
| Type | Description |
|---|---|
Run
|
Run object. |
stop
Stop run.
Returns:
| Type | Description |
|---|---|
None
|
|
resume
Resume run.
Returns:
| Type | Description |
|---|---|
None
|
|
Kind specific methods
Kind specific methods are used to express potential behaviors of different object kinds. See the kinds section for more information.