schedulerjobs

Documentation

Index

• Constants
• type CreateRequest
  • func (r CreateRequest) PeriodicTask() smp.PeriodicTask
• type Option
• type Plugin
  • func (p *Plugin) Init(s smp.PeriodicTaskStorage) error
  • func (p *Plugin) Name() string
  • func (p *Plugin) Register(mux *flow.Mux)
• type UpdateRequest
  • func (r UpdateRequest) PeriodicTask(id string) smp.PeriodicTask

Constants

const (
	PluginName = "/api/v1/jobs"
)

Types

type CreateRequest

type CreateRequest struct {
	CronExpr string   `json:"cron_expr,omitempty" validate:"required,min=9,max=254"`
	JobCode  string   `json:"job_code,omitempty" validate:"required,max=254"`
	Payload  string   `json:"payload,omitempty"`
	Opts     []Option `json:"opts,omitempty" validate:"omitempty,dive"`
	Enabled  bool     `json:"enabled,omitempty"`
}

func (CreateRequest) PeriodicTask

func (r CreateRequest) PeriodicTask() smp.PeriodicTask

type Option

type Option struct {
	Type  smp.OptionType `json:"type,omitempty" validate:"required,max=50"`
	Value string         `json:"value,omitempty" validate:"required"`
}

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

func (*Plugin) Init

func (p *Plugin) Init(s smp.PeriodicTaskStorage) error

func (*Plugin) Name

func (p *Plugin) Name() string

Name returns user-friendly plugin name

func (*Plugin) Register

func (p *Plugin) Register(mux *flow.Mux)

type UpdateRequest

type UpdateRequest struct {
	CronExpr string    `json:"cron_expr,omitempty" validate:"omitempty,min=9,max=254"`
	JobCode  string    `json:"job_code,omitempty" validate:"omitempty,max=254"`
	Payload  *string   `json:"payload,omitempty"`
	Opts     *[]Option `json:"opts,omitempty" validate:"omitempty,dive"`
	Enabled  *bool     `json:"enabled,omitempty"`
}

func (UpdateRequest) PeriodicTask

func (r UpdateRequest) PeriodicTask(id string) smp.PeriodicTask