Documentation
¶
Index ¶
- type Header
- type JsonSchema
- type Runner
- type ScriptRunner
- func (s *ScriptRunner) Execute(task *Task, execArgs interface{}) *TaskResult
- func (s *ScriptRunner) ExecuteAsync(task *Task, execArgs interface{})
- func (s *ScriptRunner) GetAsyncResults() <-chan *TaskResult
- func (s *ScriptRunner) GetAsyncResultsCount() int
- func (s *ScriptRunner) SetLogger(logger *logrus.Logger)
- func (s *ScriptRunner) WaitUntilComplete()
- type ScriptRunnerPool
- type ScriptSchema
- type Task
- type TaskResult
- type TaskStore
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type JsonSchema ¶
type JsonSchema struct {
Schema string `json:"$schema,omitempty" yaml:"$schema,omitempty"` // optional
ID string `json:"$id,omitempty" yaml:"$id,omitempty"` // optional
Properties map[string]*JsonSchema `json:"properties,omitempty" yaml:"properties,omitempty"` // optional
Type string `json:"type,omitempty" yaml:"type,omitempty"` // optional
Required []string `json:"required,omitempty" yaml:"required,omitempty"` // optional
}
type Runner ¶
type Runner interface {
Execute(task *Task, execArgs interface{}) *TaskResult
ExecuteAsync(task *Task, execArgs interface{})
WaitUntilComplete()
GetAsyncResults() <-chan *TaskResult
SetLogger(logger *logrus.Logger)
// contains filtered or unexported methods
}
func NewScriptRunner ¶
func NewScriptRunner() Runner
type ScriptRunner ¶
type ScriptRunner struct {
// contains filtered or unexported fields
}
func (*ScriptRunner) Execute ¶
func (s *ScriptRunner) Execute(task *Task, execArgs interface{}) *TaskResult
func (*ScriptRunner) ExecuteAsync ¶
func (s *ScriptRunner) ExecuteAsync(task *Task, execArgs interface{})
func (*ScriptRunner) GetAsyncResults ¶ added in v1.1.0
func (s *ScriptRunner) GetAsyncResults() <-chan *TaskResult
func (*ScriptRunner) GetAsyncResultsCount ¶ added in v1.1.0
func (s *ScriptRunner) GetAsyncResultsCount() int
func (*ScriptRunner) SetLogger ¶ added in v1.1.0
func (s *ScriptRunner) SetLogger(logger *logrus.Logger)
func (*ScriptRunner) WaitUntilComplete ¶
func (s *ScriptRunner) WaitUntilComplete()
type ScriptRunnerPool ¶ added in v1.1.0
type ScriptRunnerPool struct {
*ScriptRunner
// contains filtered or unexported fields
}
func (*ScriptRunnerPool) ExecuteAsync ¶ added in v1.1.0
func (p *ScriptRunnerPool) ExecuteAsync(task *Task, execArgs interface{})
type ScriptSchema ¶
type ScriptSchema struct {
Name string `json:"name,omitempty" yaml:"name,omitempty"` // optional
Description string `json:"description,omitempty" yaml:"description,omitempty"` // optional
Inputs *JsonSchema `json:"inputs" yaml:"inputs"`
Outputs *JsonSchema `json:"outputs,omitempty" yaml:"outputs,omitempty"` // optional
}
func NewScriptSchema ¶
func NewScriptSchema(name string, description string, inputs *JsonSchema, outputs *JsonSchema) *ScriptSchema
func NewScriptSchemaFromJSON ¶
func NewScriptSchemaFromJSON(jsonSchema string) (*ScriptSchema, error)
type Task ¶
type Task struct {
Name string `json:"name" yaml:"name"`
Location string `json:"location" yaml:"location"`
Accept *JsonSchema `json:"schema" yaml:"schema"`
}
func (*Task) JsonSchema ¶
func (*Task) SetSchemaFromBytes ¶
type TaskResult ¶
type TaskResult struct {
Caller *Task `json:"-"` // not serialized
Status int `json:"status"`
Reason string `json:"reason"`
Payload interface{} `json:"payload"`
}
func (*TaskResult) SetFail ¶
func (tr *TaskResult) SetFail(reason string)
type TaskStore ¶
type TaskStore struct {
// contains filtered or unexported fields
}
func NewTaskStore ¶
func (*TaskStore) DeleteTask ¶
Click to show internal directories.
Click to hide internal directories.