config

package
v0.0.0-...-3dfdb9c Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 29, 2021 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

type Config struct {
	CheckpointExecution bool
	Shell               string
}

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

type Stage struct {
	ID         string
	Args       []string
	Conditions []string
	Actions    []string
}

Stage is the consumer friendly data structure that hosts the loaded workflow definition workflow stage

type Stages

type Stages map[string][]string

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

type StateMachineTransition struct {
	From []string
	To   []string
}

StateMachineTransition is the consumer friendly data structure that hosts the loaded workflow definition state machine transition

type Transition

type Transition struct {
	From string
	To   []string
}

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

type Workflow struct {
	ID           string
	StateMachine string
	Stages       []Stage
}

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

func (WorkflowDefinition) Workflow

func (wd WorkflowDefinition) Workflow(workflowID string) (Workflow, error)

Workflow returns the workflow associated to the specified workflowID

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL