Function object

The Function object comes with three sets of methods: CRUD methods, one run method 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
None

refresh

Refresh object from backend.

Returns:

Type	Description
ContextEntity	Entity refreshed.

Run method

The run() method is used to execute the function.

run

Run function. This method creates a new run and executes it.

Parameters:

Name	Type	Description	Default
action	str	Action to execute.	required
local_execution	bool	Flag to determine if object has local execution.	False
wait	bool	Flag to wait for execution.	False
log_info	bool	Flag to log information while waiting.	True
**kwargs	dict	Keyword arguments passed to Task and Run builders.	{}

Returns:

Type	Description
Run	Run instance.

Kind specific methods

Kind specific methods are used to express potential behaviors of different object kinds. See the kinds section for more information.