engine

Documentation

Index

• type Engine
  • func New(st *store.Store, providers *provider.Registry) *Engine
  • func (e *Engine) RunJob(ctx context.Context, jobID string) (JobResult, error)
  • func (e *Engine) RunJobOnce(ctx context.Context, jobID string) (RunResult, error)
  • func (e *Engine) RunJobUntilIdle(ctx context.Context, jobID string, maxPasses int) (RunResult, error)
  • func (e *Engine) RunOnce(ctx context.Context, limit int) (RunResult, error)
  • func (e *Engine) RunUntilIdle(ctx context.Context, limit, maxPasses int) (RunResult, error)
• type JobResult
• type RunResult

Types

type Engine

type Engine struct {
	Store     *store.Store
	Providers *provider.Registry
}

func New

func New(st *store.Store, providers *provider.Registry) *Engine

func (*Engine) RunJob

func (e *Engine) RunJob(ctx context.Context, jobID string) (JobResult, error)

func (*Engine) RunJobOnce

func (e *Engine) RunJobOnce(ctx context.Context, jobID string) (RunResult, error)

func (*Engine) RunJobUntilIdle

func (e *Engine) RunJobUntilIdle(ctx context.Context, jobID string, maxPasses int) (RunResult, error)

func (*Engine) RunOnce

func (e *Engine) RunOnce(ctx context.Context, limit int) (RunResult, error)

func (*Engine) RunUntilIdle

func (e *Engine) RunUntilIdle(ctx context.Context, limit, maxPasses int) (RunResult, error)

type JobResult

type JobResult struct {
	Completed bool
	StepsRun  int
}

type RunResult

type RunResult struct {
	JobsSeen      int
	JobsCompleted int
	JobsFailed    int
	StepsRun      int
}