Parallel: Parallel State causes parallel execution of "branches".

In DyfanJones/aws-step-functions-data-science-sdk-r: R SDK for `AWS Stepfunctions`

Description

A Parallel state causes the interpreter to execute each branch as concurrently as possible, and wait until each branch terminates (reaches a terminal state) before processing the next state in the Chain.

Super classes

stepfunctions::Block -> stepfunctions::State -> Parallel

Methods

Public methods

• Parallel$new()

• Parallel$allowed_fields()

• Parallel$add_branch()

• Parallel$to_list()

• Parallel$clone()

Inherited methods

• stepfunctions::Block$is_field_allowed()

• stepfunctions::Block$to_json()

• stepfunctions::State$.next()

• stepfunctions::State$accept()

• stepfunctions::State$add_catch()

• stepfunctions::State$add_retry()

• stepfunctions::State$format()

• stepfunctions::State$output()

• stepfunctions::State$update_parameters()

---

Method new()

Initialize Parallel state class

Usage

Parallel$new(
  state_id,
  comment = NULL,
  input_path = NULL,
  parameters = NULL,
  result_path = NULL,
  output_path = NULL,
  ...
)

Arguments

state_id

(str): State name whose length **must be** less than or equal to 128 unicode characters. State names **must be** unique within the scope of the whole state machine.

comment

(str, optional): Human-readable comment or description. (default: None)

input_path

(str, optional): Path applied to the state’s raw input to select some or all of it; that selection is used by the state. (default: '$')

parameters

(list, optional): The value of this field becomes the effective input for the state.

result_path

(str, optional): Path specifying the raw input’s combination with or replacement by the state’s result. (default: '$')

output_path

(str, optional): Path applied to the state’s output after the application of 'result_path', producing the effective output which serves as the raw input for the next state. (default: '$')

...

: Extra field names to pass to Block class

---

Method allowed_fields()

allowed extra fields

Usage

Parallel$allowed_fields()

---

Method add_branch()

Add a 'State' or 'Chain' as a branch to the Parallel state.

Usage

Parallel$add_branch(branch)

Arguments

branch

(State or Chain): State or Chain to attach as a branch to the Parallel state.

---

Method to_list()

Convert class to list ready to be translated for Amazon States Language https://states-language.net/spec.html.

Usage

Parallel$to_list()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Parallel$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DyfanJones/aws-step-functions-data-science-sdk-r documentation built on Dec. 17, 2021, 5:31 p.m.