job

Documentation

Index

• type Job
  • func NewJob(ctx context.Context, name string, schedule string, ...) *Job
  • func (j *Job) AddToScheduler(cronRunner *cron.Cron) error
  • func (j Job) GetEntry(cronRunner *cron.Cron) *cron.Entry
  • func (j Job) RemoveFromScheduler(cronRunner *cron.Cron)
  • func (j Job) Run()
  • func (j *Job) RunOnStart() *Job
  • func (j *Job) SetID(id string) *Job
  • func (j *Job) SetTimeout(t time.Duration) *Job
• type JobRuntime

Types

type Job

type Job struct {
	context.Context
	Name            string
	Schedule        string
	AllowConcurrent bool
	Timeout         time.Duration
	Fn              func(ctx JobRuntime) error
	RunNow          bool
	ID              string
	// contains filtered or unexported fields
}

func NewJob

func NewJob(ctx context.Context, name string, schedule string, fn func(ctx JobRuntime) error) *Job

func (*Job) AddToScheduler

func (j *Job) AddToScheduler(cronRunner *cron.Cron) error

func (Job) GetEntry

func (j Job) GetEntry(cronRunner *cron.Cron) *cron.Entry

func (Job) RemoveFromScheduler

func (j Job) RemoveFromScheduler(cronRunner *cron.Cron)

func (Job) Run

func (j Job) Run()

func (*Job) RunOnStart

func (j *Job) RunOnStart() *Job

func (*Job) SetID

func (j *Job) SetID(id string) *Job

func (*Job) SetTimeout

func (j *Job) SetTimeout(t time.Duration) *Job

type JobRuntime

type JobRuntime struct {
	context.Context
	Job     Job
	Started time.Time
	Ended   time.Time
}