Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 2.52 KB

state.md

File metadata and controls

60 lines (41 loc) · 2.52 KB
Raw

State

The framework provides a PipelineRunState class that represents the state of a pipeline run. It's used to evaluate how an activity behaves for a given a specific input.

Interface

The constructor of the PipelineRunState class has the following properties:

  • parameters: A list of RunParameter instances representing the input parameters of the pipeline run.
  • variables: A list of PipelineRunVariable instances representing the variables of the pipeline run.
  • activity_results: A list of activity results that can be used to simulate the output of activities in the pipeline run.
  • iteration_item: An optional iteration item that can be used to simulate the iteration item of a ForEach activity.

The PipelineRunState class has the following methods:

  • add_activity_result: Adds a result for an activity to the state. This is useful if an expression in an activity references another activities output, like: @activity('another_activity_name').output.some_field.
  • set_iteration_item: Sets the iteration item of the state. This is useful if an expression in an activity references the iteration item of a ForEach activity, like: @item().JobId.

Usage

Parameters and variables

In the scenario where an activity has an expression that references a global parameter called BaseUrl and a variable called JobName, the PipelineRunState can be used to simulate the evaluation of the expression.

state = PipelineRunState(
    parameters=[
        RunParameter(RunParameterType.Global, "BaseUrl", "https://example.com"),
    ],
    variables=[
        PipelineRunVariable("JobName", "Job-123"),
    ])

Activity results

In the scenario where an activity has an expression that references the output of another activity activity('another_activity_name').output.some_field, the PipelineRunState can be used to configure the output of the another_activity_name activity.

Via the constructor:

state = PipelineRunState(
    activity_results=[
        ActivityResult("another_activity_name", DependencyCondition.SUCCEEDED, {"some_field": "some_value!"}),
    ])

Via a method on an existing state:

state.add_activity_result("another_activity_name", DependencyCondition.SUCCEEDED, {"some_field": "some_value!"})

Iteration item

In the scenario where an activity has an expression that references the iteration item of a ForEach activity @item().JobId, the PipelineRunState can be used to configure the iteration item.

state.set_iteration_item({"JobId": "123"})