Documentation
¶
Index ¶
Constants ¶
const (
InputTypeRequest = "request"
)
InputTypeRequest and others represent consts for Directives
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CallableFn ¶
type CallableFn struct {
Fn string `yaml:"fn,omitempty" json:"fn,omitempty"`
As string `yaml:"as,omitempty" json:"as,omitempty"`
With map[string]string `yaml:"with,omitempty" json:"with,omitempty"`
OnErr *FnOnErr `yaml:"onErr,omitempty" json:"onErr,omitempty"`
FQFN string `yaml:"-" json:"fqfn"` // calculated during Validate
}
CallableFn is a fn along with its "variable name" and "args"
type Directive ¶
type Directive struct {
Identifier string `yaml:"identifier"`
AppVersion string `yaml:"appVersion"`
AtmoVersion string `yaml:"atmoVersion"`
Headless bool `yaml:"headless,omitempty"`
Runnables []Runnable `yaml:"runnables"`
Handlers []Handler `yaml:"handlers,omitempty"`
Schedules []Schedule `yaml:"schedules,omitempty"`
}
Directive describes a set of functions and a set of handlers that take an input, and compose a set of functions to handle it
func (*Directive) FindRunnable ¶ added in v0.2.3
type Executable ¶
type Executable struct {
CallableFn `yaml:"callableFn,inline" json:"callableFn"`
Group []CallableFn `yaml:"group,omitempty" json:"group,omitempty"`
ForEach *ForEach `yaml:"forEach,omitempty" json:"forEach,omitempty"`
}
Executable represents an executable step in a handler
func (*Executable) IsFn ¶
func (e *Executable) IsFn() bool
IsFn returns true if the executable is a group
func (*Executable) IsForEach ¶
func (e *Executable) IsForEach() bool
IsForEach returns true if the exectuable is a ForEach
func (*Executable) IsGroup ¶
func (e *Executable) IsGroup() bool
IsGroup returns true if the executable is a group
type FnOnErr ¶
type FnOnErr struct {
Code map[int]string `yaml:"code,omitempty" json:"code,omitempty"`
Any string `yaml:"any,omitempty" json:"any,omitempty"`
Other string `yaml:"other,omitempty" json:"other,omitempty"`
}
FnOnErr describes how to handle an error from a function call
type ForEach ¶
type ForEach struct {
In string `yaml:"in" json:"in"`
Fn string `yaml:"fn" json:"fn"`
As string `yaml:"as" json:"as"`
OnErr *FnOnErr `yaml:"onErr,omitempty" json:"onErr,omitempty"`
CallableFn CallableFn `yaml:"-" json:"callableFn"` // calculated during Validate
}
type Handler ¶
type Handler struct {
Input Input `yaml:"input,inline" json:"input"`
Steps []Executable `yaml:"steps" json:"steps"`
Response string `yaml:"response,omitempty" json:"response,omitempty"`
}
Handler represents the mapping between an input and a composition of functions
type Input ¶
type Input struct {
Type string `yaml:"type" json:"type"`
Method string `yaml:"method" json:"method"`
Resource string `yaml:"resource" json:"resource"`
}
Input represents an input source
type Runnable ¶
type Runnable struct {
Name string `yaml:"name" json:"name"`
Namespace string `yaml:"namespace" json:"namespace"`
Lang string `yaml:"lang" json:"lang"`
Version string `yaml:"version" json:"version"`
DraftVersion string `yaml:"-" json:"draftVersion,omitempty"`
APIVersion string `yaml:"apiVersion,omitempty" json:"apiVersion,omitempty"`
FQFN string `yaml:"fqfn,omitempty" json:"fqfn,omitempty"`
FQFNURI string `yaml:"fqfnUri" json:"fqfnURI,omitempty"`
ModuleRef *moduleref.WasmModuleRef `yaml:"-" json:"moduleRef,omitempty"`
}
Runnable is the structure of a .runnable.yaml file
type Schedule ¶
type Schedule struct {
Name string `yaml:"name" json:"name"`
Every ScheduleEvery `yaml:"every" json:"every"`
State map[string]string `yaml:"state,omitempty" json:"state,omitempty"`
Steps []Executable `yaml:"steps" json:"steps"`
}
Schedule represents the mapping between an input and a composition of functions
func (*Schedule) NumberOfSeconds ¶
NumberOfSeconds calculates the total time in seconds for the schedule's 'every' value
type ScheduleEvery ¶
type ScheduleEvery struct {
Seconds int `yaml:"seconds,omitempty" json:"seconds,omitempty"`
Minutes int `yaml:"minutes,omitempty" json:"minutes,omitempty"`
Hours int `yaml:"hours,omitempty" json:"hours,omitempty"`
Days int `yaml:"days,omitempty" json:"days,omitempty"`
}
ScheduleEvery represents the 'every' value for a schedule
Source Files