Skip to main content

Type Reference

This document provides a comprehensive reference for all type constants used in Osmedeus workflows.

WorkflowKind

The WorkflowKind type defines the category of a workflow. Each workflow must declare exactly one kind.

Helper Methods

  • IsModule() - Returns true if workflow is a module
  • IsFlow() - Returns true if workflow is a flow
  • IsFragment() - Returns true if workflow is a fragment

StepType

The StepType type defines the execution behavior of a step within a module or fragment.

Helper Methods

  • IsBashStep() - Returns true if step is bash type
  • IsFunctionStep() - Returns true if step is function type
  • IsParallelStep() - Returns true if step is parallel-steps type
  • IsForeachStep() - Returns true if step is foreach type
  • IsRemoteBashStep() - Returns true if step is remote-bash type
  • IsHTTPStep() - Returns true if step is http type
  • IsLLMStep() - Returns true if step is llm type
  • IsFragmentStep() - Returns true if step is fragment-step type

TriggerType

The TriggerType type defines how workflows can be triggered.

RunnerType

The RunnerType type defines the execution environment for steps.

VariableType

The VariableType type defines input validation for workflow parameters.

TargetType

The TargetType type defines target input classification.

ActionType

The ActionType type defines handlers for on_success and on_error events.

StepStatus

The StepStatus type represents the execution state of a step.

RunStatus

The RunStatus type represents the overall run state.

Severity (Linter)

The Severity type defines lint issue severity levels.

OutputFormat (Linter)

The OutputFormat type defines linter output formats.

OverrideMode (Inheritance)

The OverrideMode type defines merge strategies for workflow inheritance. Used in the override.steps.mode and override.modules.mode fields when inheriting workflows.

Summary Table