cronjob

README

cron 任务管理

Documentation

Index

• Constants
• type CronJob
  • func NewCronJob(spec CronJobSpec) *CronJob
  • func (c *CronJob) TableName() string
• type CronJobSpec
  • func NewCronJobSpec(cron string, spec task.TaskSpec) *CronJobSpec
  • func (t *CronJobSpec) GetEnabled() bool
  • func (t *CronJobSpec) SetDescription(desc string) *CronJobSpec
  • func (t *CronJobSpec) SetName(name string) *CronJobSpec
• type CronJobStatus
• type DeleteCronJobRequest
• type DescribeCronJobRequest
• type QueryCronJobRequest
  • func NewQueryCronJobRequest() *QueryCronJobRequest
• type Service
  • func GetService() Service
• type UpdateCronJobRequest

Constants

const (
	APP_NAME = "cronjobs"
)

Types

type CronJob

type CronJob struct {
	// 任务Id
	Id string `json:"id" gorm:"column:id;type:string;primary_key;" unique:"true" description:"Id"`
	// 创建时间
	CreatedAt time.Time `` /* 126-byte string literal not displayed */
	// 关联的cron实例Id
	RefInstanceId int `json:"ref_instance_id" gorm:"column:ref_instance_id;" description:"关联的cron实例Id"`
	// Cronjob参数
	CronJobSpec
	// 状态
	CronJobStatus
}

func NewCronJob

func NewCronJob(spec CronJobSpec) *CronJob

func (*CronJob) TableName

func (c *CronJob) TableName() string

type CronJobSpec

type CronJobSpec struct {
	// Cron表达式
	Cron string `json:"cron" gorm:"column:cron;type:varchar(120)" description:"Cron表达式"`
	// 是否启用改Cron
	Enabled *bool `json:"enabled" gorm:"column:enabled;type:bool" description:"是否启用改Cron"`
	// Task执行参数
	task.TaskSpec
}

func NewCronJobSpec

func NewCronJobSpec(cron string, spec task.TaskSpec) *CronJobSpec

func (*CronJobSpec) GetEnabled

func (t *CronJobSpec) GetEnabled() bool

func (*CronJobSpec) SetDescription

func (t *CronJobSpec) SetDescription(desc string) *CronJobSpec

func (*CronJobSpec) SetName

func (t *CronJobSpec) SetName(name string) *CronJobSpec

type CronJobStatus

type CronJobStatus struct {
	// CronJob执行的Node节点信息
	Node string `json:"node"`
}

type DeleteCronJobRequest

type DeleteCronJobRequest struct {
	DescribeCronJobRequest
}

type DescribeCronJobRequest

type DescribeCronJobRequest struct {
	// 任务Id
	Id string `json:"id" description:"Id"`
}

type QueryCronJobRequest

type QueryCronJobRequest struct {
	// 分页参数
	*request.PageRequest
	// 任务名称
	Name string `json:"name"`
}

func NewQueryCronJobRequest

func NewQueryCronJobRequest() *QueryCronJobRequest

type Service

type Service interface {
	// 添加CronJob
	AddCronJob(context.Context, *CronJobSpec) (*CronJob, error)
	// 查询列表
	QueryCronJob(context.Context, *QueryCronJobRequest) (*types.Set[*CronJob], error)
	// 查询详情
	DescribeCronJob(context.Context, *DescribeCronJobRequest) (*CronJob, error)
	// 更新Cronjob
	UpdateCronJob(context.Context, *UpdateCronJobRequest) (*CronJob, error)
	// 删除Cronjob
	DeleteCronJob(context.Context, *DeleteCronJobRequest) (*CronJob, error)
}

func GetService

func GetService() Service

type UpdateCronJobRequest

type UpdateCronJobRequest struct {
}