client

Documentation

Index

• func API() (core.CoreClient, error)
• type Event
• type Result
• type Task
• type Workflow
  • func (wf *Workflow) Start() (err error)
  • func (wf *Workflow) Stop() (err error)

Functions

func API

func API() (core.CoreClient, error)

API returns the client necessary to access the API

Types

type Event

type Event struct {
	ServiceID string
	Name      string
}

Event is a struct that contains all the informations to start a workflow. This is the **when** in the workflow

type Result

type Result struct {
	ServiceID string
	Name      string
	Output    string
}

Result is a struct that contains all the informations to start a workflow. This is the **when** in the workflow

type Task

type Task struct {
	ServiceID string
	Name      string
	Inputs    func(interface{}) interface{}
}

Task is a struct that contains the details of a task a task should be associated to a workflow. A task is corresponding to the **then** in a workflow

type Workflow

type Workflow struct {
	OnEvent  *Event
	OnResult *Result
	Execute  *Task
	// contains filtered or unexported fields
}

Workflow is a struct that contains all the details of a workflow. A workflow contains an event source and triggers one or multiple tasks. The workflow is what is created on the **when**

func (*Workflow) Start

func (wf *Workflow) Start() (err error)

Start is the function to start the workflow

func (*Workflow) Stop

func (wf *Workflow) Stop() (err error)

Stop will stop all the services in your workflow