flow

class virtualitics_sdk.flow.flow.Flow(name, description, image_path=None, is_shareable=False, sort_key=None)

Bases: object

Flows are how workflows are organized in Predict. A flow can contain many Step s that can get inputs, run computation, and show results.

Parameters:
  • name (str) – The name of the Flow.

  • description (str) – The Flow description

  • image_path (Optional[str]) – The base64 encoding of an image or a public link to an image, defaults to None

  • is_shareable (bool) – Whether a given Flow is shareable, defaults to False

  • sort_key (Optional[str]) – An optional value to sort the App by, this controls the sort order of Apps on the home page

activate(user, generate_new_id=False, is_self_service=False, fully_qualified_flow_name=None)
Return type:

dict

add(step)
Return type:

Flow

chain(ordered_steps, lock=True)

Add all steps with one function. Locks flow by default.

Parameters:

ordered_steps (List[Step]) – Ordered list of Steps to be added.

check_step_map(step)
copy()
enumeration()
get_data(is_self_service=False, fully_qualified_flow_name=None)
lock()