WorkflowStep<INPUT, OUTPUT> class

Represents a single step within a workflow.

Workflow steps define individual actions or phases in a process, with optional input/output types, guard rails for validation, and a specific step type that categorizes the action.

Inheritance
Annotations
  • @JsonSerializable.new(includeIfNull: true, explicitToJson: true, genericArgumentFactories: true)

Constructors

WorkflowStep({required WorkflowStepType workflowStepType, List<GuardRailDto>? guardRails, INPUT? input, OUTPUT? output})
Creates a WorkflowStep with the given properties.
WorkflowStep.fromJson(Map<String, dynamic> json, INPUT fromJsonINPUT(Object? json), OUTPUT fromJsonOUTPUT(Object? json))
factory

Properties

guardRails → List<GuardRailDto>?
Optional guard rails that validate or constrain this step's execution.
final
hashCode → int
The hash code for this object.
no setterinherited
input → INPUT?
Optional input data for this workflow step.
final
mdFactory ↔ TMdFactory<TWriteable>?
Returns a function that builds a Markdown string from a JSON map.
getter/setter pairinherited
output → OUTPUT?
Optional output data produced by this workflow step.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
workflowStepType → WorkflowStepType
The type of workflow step this represents.
final
xmlBuilder ↔ String Function(Map<String, dynamic> json)?
Returns a function that builds an XML string from a JSON map.
getter/setter pairinherited
yamlBuilder ↔ String Function(TWriteable writeable)?
Returns a function that builds a YAML string from a JSON map.
getter/setter pairinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Converts the object to a Firestore-compatible map.
override
toJsonWithConverters(Object? toJsonINPUT(INPUT value), Object? toJsonOUTPUT(OUTPUT value)) → Map<String, dynamic>
JSON serialization method for generic types. Requires converters for INPUT and OUTPUT types.
toMarkdown({TMdFactory<TWriteable>? mdFactory}) → String
Converts this object to a Markdown string.
inherited
toString() → String
A string representation of this object.
override
toXml() → String
Converts this object to an XML string.
inherited
toYaml() → String
Converts this object to a YAML string.
inherited
validate<T>() → TurboResponse<T>?
Validates the object's data before writing to Firestore.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited