ConditionStep: Workflow ConditionStep class

In DyfanJones/sagemaker-r-workflow: sagemaker pipeline and workflows

Workflow ConditionStep class

Description

Conditional step for pipelines to support conditional branching in the execution of steps.

Super classes

sagemaker.workflow::Entity -> sagemaker.workflow::Step -> ConditionStep

Public fields

conditions

The name of the step.

if_steps

A list of 'sagemaker.workflow.steps.Step' and 'sagemaker.workflow.step_collections.StepCollection' instances

else_steps

A list of 'sagemaker.workflow.steps.Step' and 'sagemaker.workflow.step_collections.StepCollection' instances

Active bindings

arguments

The arguments dict that is used to define the conditional branching in the pipeline.

properties

A simple Properties object with 'Outcome' as the only property

Methods

Public methods

• ConditionStep$new()

• ConditionStep$clone()

Inherited methods

• sagemaker.workflow::Step$add_depends_on()

• sagemaker.workflow::Step$format()

• sagemaker.workflow::Step$to_request()

---

Method new()

Construct a ConditionStep for pipelines to support conditional branching. If all of the conditions in the condition list evaluate to True, the 'if_steps' are marked as ready for execution. Otherwise, the 'else_steps' are marked as ready for execution.

Usage

ConditionStep$new(
  name,
  depends_on = NULL,
  display_name = NULL,
  description = NULL,
  conditions = NULL,
  if_steps = NULL,
  else_steps = NULL
)

Arguments

name

(str): The name of the step.

depends_on

(List[str]): The list of step names the current step depends on

display_name

(str): The display name of the condition step.

description

(str): The description of the condition step.

conditions

(List[Condition]): A list of 'sagemaker.workflow.conditions.Condition' instances.

if_steps

(List[Union[Step, StepCollection]]): A list of 'sagemaker.workflow.steps.Step' and 'sagemaker.workflow.step_collections.StepCollection' instances that are marked as ready for execution if the list of conditions evaluates to True.

else_steps

(List[Union[Step, StepCollection]]): A list of 'sagemaker.workflow.steps.Step' and 'sagemaker.workflow.step_collections.StepCollection' instances that are marked as ready for execution if the list of conditions evaluates to False.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ConditionStep$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DyfanJones/sagemaker-r-workflow documentation built on April 3, 2022, 11:28 p.m.