engine

Documentation

Index

• type Engine
  • func NewEngine(app *inits.App) (Engine, error)
  • func (engine *Engine) ExecuteWorkflow(workflowID uuid.UUID) error
• type Poller
• type RESTHook
• type Subscription
• type Trigger
• type Workflow
  • func (workflow *Workflow) Execute() error
• type WorkflowInstance

Types

type Engine

type Engine struct {
	*inits.App
	Model models.Engine
}

Engine represents an engine instance.

func NewEngine

func NewEngine(app *inits.App) (Engine, error)

NewEngine creates a new workflow engine.

func (*Engine) ExecuteWorkflow

func (engine *Engine) ExecuteWorkflow(workflowID uuid.UUID) error

ExecuteWorkflow takes a workflow object and executes it.

type Poller

type Poller struct {
	Interval int
}

Poller polls for information on a particular endpoint periodically.

type RESTHook

type RESTHook struct {
	CallbackURL  string
	ClientDomain string
}

RESTHook is a webhook with subscription management ability.

type Subscription

type Subscription interface {
}

Subscription represent a subscription type that can send payload to its subscribers.

type Trigger

type Trigger struct {
	Sub Subscription
}

Trigger represents the first step of a workflow that watches for events before running subsequent steps.

type Workflow

type Workflow struct {
	Model          *models.Workflow
	WorkflowConfig *configs.WorkflowConfig
}

Workflow represents a runnable workflow.

func (*Workflow) Execute

func (workflow *Workflow) Execute() error

Execute starts the execution of workflow run.

type WorkflowInstance

type WorkflowInstance struct {
	Model    *models.WorkflowInstance
	Workflow *Workflow
}

WorkflowInstance represents a running, paused or stopped workflow instance.