step_in_line.stepfunctions.inputs.StepInput

class documentation

class StepInput(Placeholder): (source)

Constructor: StepInput(schema, **kwargs)

Top-level class for step input placeholders.

Method	`__init__`	schema (dict, optional): Schema for the placeholder collection. (default: None)
Instance Variable	`json_str_template`	Undocumented
Method	`_create_variable`	Creates a placeholder variable for Step Input. A placeholder variable can only be created if the collection is not immutable due to a pre-specified schema.

Inherited from Placeholder:

Method	`__contains__`	Containment check operator for placeholder variables.
Method	`__getitem__`	Subscript operator to build placeholder variables.
Method	`contains`	Check if the placeholder collection contains the specified placeholder variable.
Method	`get`	Create a placeholder variable with an associated type.
Method	`get_schema_as_dict`	Generate a schema for the placeholder collection as a Python dictionary.
Method	`get_schema_as_json`	Generate a schema for the placeholder collection as a JSON formatted string.
Method	`to_jsonpath`	Returns a JSON path representation of the placeholder variable to be used for step parameters.
Method	`validate`	Validate a specified input against the placeholder collection schema.
Instance Variable	`immutable`	Undocumented
Instance Variable	`name`	Undocumented
Instance Variable	`parent`	Undocumented
Instance Variable	`schema`	Undocumented
Instance Variable	`store`	Undocumented
Instance Variable	`type`	Undocumented
Method	`_get_path`	Get path to a placeholder variable node in the collection.
Method	`_is_empty`	Check if the store for a placeholder collection/variable is empty.
Method	`_is_valid_name`	Undocumented
Method	`_join_path`	Undocumented
Method	`_make_immutable`	Make a placeholder collection (including all variables contained) immutable.
Method	`_set_schema`	Set the schema for a placeholder collection.

def __init__(self, schema=None, **kwargs): (source) ¶

overrides step_in_line.stepfunctions.inputs.Placeholder.__init__

Args:: schema (dict, optional): Schema for the placeholder collection. (default: None)
Keyword Args:: name (str, optional): Name of the placeholder variable. (default: None) type (type, optional): Type of the placeholder variable. (default: None) parent (Placeholder, optional): Parent variable for a placeholder variable. (default: None)

json_str_template: str = (source) ¶

overrides step_in_line.stepfunctions.inputs.Placeholder.json_str_template

Undocumented

def _create_variable(self, name, parent, type=None): (source) ¶

overrides step_in_line.stepfunctions.inputs.Placeholder._create_variable

Creates a placeholder variable for Step Input. A placeholder variable can only be created if the collection is not immutable due to a pre-specified schema.