step

class virtualitics_sdk.flow.step.Step(title, description, parent, type, page, allow_filters=False, uses_pyspark=False, uses_pyvip=False, uses_snowflake=False, overrides_action=False, await_actions=True, override_skips_default=False, alerts=None, **kwargs)

Bases: ABC

A Step is the basic unit of a flow. Steps can be chained together to form a flow.

Parameters:

  • title (str) – The title of the step.

  • description (str) – A description of what the step does.

  • parent (str) – The parent step.

  • type (StepType) – The Step type.

  • page (Page) – The initial Page for this step.

  • allow_filters (bool) – whether to allow filters, defaults to False.

  • overrides_action (bool) – whether this step overrides the default action for this step type, defaults to False.

  • await_actions (bool) – whether this step overrides must wait for an action to continue to the next page, defaults to True.

  • override_skips_default (bool) – When true and overrides_action is true, this flag defines whether to skip over the default step action, defaults to False.

action_override(flow_metadata)

Overriding this method in a step will run this function after the step has been completed. To make sure this runs, set overrides_action to True. If you want to skip the defuault behavior for an action (i.e. for custom data processing of an input file), set override_skips_default to True as well.

Parameters:

flow_metadata (Dict[str, Any]) – Relevant information about the current step which is useful to

access the StoreInterface

activate(parent_flow, is_self_service=False, user=None)
copy()
property index
property message
on_action_success(store_interface, *args, **kwargs)
on_run_success(store_interface, *args, **kwargs)
property progress
progress_update(progress, message)
abstract run(flow_metadata, spark_session=None, pyvip_client=None)
set_params(**kwargs)

add to the class any additional keyword arguments not already assigned. Prevents accidentally overriding class attributes that already exist (so flow developer doesn’t override _progress or another variable with unintended consequences)

Parameters:

kwargs

Returns:

class virtualitics_sdk.flow.step.StepType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

The type of Step being created. INPUT: A Step should be of type input if it contains input elements. DASHBOARD: Marking steps as Dashboard Steps helps them be easily found in the Dashboards section. RESULTS: If a step contains neither inputs or dashboards it should be a Results step.

DASHBOARD = 3
DATA_LAB = 1
INPUT = 0
RESULTS = 2