Documentation ¶
Index ¶
- type Config
- type Flowit
- type Stage
- type Stages
- type StateMachine
- type StateMachineTransition
- type Transition
- type Variables
- type Workflow
- type WorkflowDefinition
- func (wd WorkflowDefinition) Stage(workflowID, stageID string) (Stage, error)
- func (wd WorkflowDefinition) Stages(workflowID string) ([]Stage, error)
- func (wd WorkflowDefinition) StateMachine(stateMachineID string) (StateMachine, error)
- func (wd WorkflowDefinition) Workflow(workflowID string) (Workflow, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
Config is the consumer friendly data structure that hosts the loaded workflow definition configuration
type Flowit ¶
type Flowit struct { Version string Config Config Variables Variables StateMachines []StateMachine Workflows []Workflow }
Flowit is the consumer friendly data structure that hosts the loaded workflow definition main body
type Stage ¶
Stage is the consumer friendly data structure that hosts the loaded workflow definition workflow stage
type Stages ¶
Stages is the consumer friendly data structure that hosts the loaded workflow definition tag stages
type StateMachine ¶
type StateMachine struct { ID string Stages []string InitialStage string FinalStages []string Transitions []StateMachineTransition }
StateMachine is the consumer friendly data structure that hosts the loaded workflow definition state machine
type StateMachineTransition ¶
StateMachineTransition is the consumer friendly data structure that hosts the loaded workflow definition state machine transition
type Transition ¶
Transition is the consumer friendly data structure that hosts the loaded workflow definition branch transition
type Variables ¶
type Variables map[string]interface{}
Variables is the consumer friendly data structure that hosts the loaded workflow definition variables
type Workflow ¶
Workflow is the consumer friendly data structure that hosts the loaded workflow definition workflow
type WorkflowDefinition ¶
type WorkflowDefinition struct {
Flowit Flowit
}
WorkflowDefinition is the consumer friendly data structure that hosts the loaded workflow definition
func Load ¶
func Load(fileLocation string) (*WorkflowDefinition, error)
Load reads, parses and validates the specified configuration file and returns consumable workflow definition
func (WorkflowDefinition) Stage ¶
func (wd WorkflowDefinition) Stage(workflowID, stageID string) (Stage, error)
Stage returns the loaded workflow definition stage for the specified workflowID and stage
func (WorkflowDefinition) Stages ¶
func (wd WorkflowDefinition) Stages(workflowID string) ([]Stage, error)
Stages returns the loaded workflow definition stages for the specified workflowID
func (WorkflowDefinition) StateMachine ¶
func (wd WorkflowDefinition) StateMachine(stateMachineID string) (StateMachine, error)
StateMachine receives a state machine ID and returns the correspoding state machine