Pass: Pass State Class

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

Description

Pass State simply passes its input to its output, performing no work. Pass States are useful when constructing and debugging state machines.

Super classes

stepfunctions::Block -> stepfunctions::State -> Pass

Methods

Public methods

• Pass$new()

• Pass$allowed_fields()

• Pass$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$to_list()

• stepfunctions::State$update_parameters()

---

Method new()

Initialize Pass state class

Usage

Pass$new(
  state_id,
  comment = NULL,
  input_path = NULL,
  parameters = NULL,
  result_path = NULL,
  result = 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: '$')

result

(str, optional): If present, its value is treated as the output of a virtual task, and placed as prescribed by the 'result_path' field, if any, to be passed on to the next state. If 'result' is not provided, the output is the input.

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

Pass$allowed_fields()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Pass$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.