job

type CreateJobRequest struct {
	// 所属域
	Domain string `json:"domain" gorm:"column:domain" validate:"required"`
	// 所属空间
	Namespace string `json:"namespace" gorm:"column:namespace" validate:"required"`
	// 创建人
	CreateBy string `json:"create_by" gorm:"column:create_by"`
	// job定义
	CreateJobSpec
}

type CreateJobSpec struct {
	// 执行器类型, 默认采用k8s job执行
	RunnerType task.TYPE `json:"runner_type" gorm:"column:runner_type;type:varchar(32)" validate:"required"`
	// 执行器定义, 比如 k8s job 定义中的 &corev1.PodSpec{}, 是YAML模版
	RunTemplate string `json:"run_template" gorm:"column:run_template;type:text"`
	// 运行时 用户传人的参数说明
	InputParams []*RunParam `json:"input_params" gorm:"column:input_params;serializer:json;type:json"`
	// 运行时 用户传人的参数说明
	OutputParams []*RunParam `json:"output_params" gorm:"column:output_params;serializer:json;type:json"`
	// 图片
	Logo string `json:"logo" gorm:"column:logo"`
	// 图标
	Icon string `json:"icon" gorm:"column:icon"`
	// 名称, 不能包含特殊字符(. , #)
	Name string `json:"name" validate:"required" gorm:"column:name;type:varchar(128)"`
	// 展示名称
	DisplayName string `json:"display_name" gorm:"column:display_name;type:varchar(128)"`
	// 是否是公开Job, 默认只能本空间内访问
	VisiableMode resource.VISIABLE `json:"visiable_mode" gorm:"column:visiable_mode;type:int"`
	// 描述, Job功能概述
	Description string `json:"description" gorm:"column:description;type:text"`
	// Job 的Readme说明文档, 支持Markdown格式
	Readme string `json:"readme" gorm:"column:readme;type:text"`
	// 文档的URL地址
	DocumentUrl string `json:"document_url" gorm:"column:document_url;type:varchar(512)"`
	// 标签
	Labels map[string]string `json:"labels" gorm:"column:labels;serializer:json;type:json"`
	// 扩展属性
	Extension map[string]string `json:"extension" gorm:"column:extension;serializer:json;type:json"`
}

type DeleteJobRequest struct {
	DescribeJobRequest
}

type DescribeJobRequest struct {
	JobIdOrName string `json:"id_or_name"`
}

type EnumOption struct {
	// 选项的说明
	Label string `json:"label"`
	// 选项的值
	Value string `json:"value" validate:"required"`
	// 扩展属性
	Extensions map[string]string `json:"extensions"`
}

type HttpEnumConfig struct {
	// 基于枚举的URL, 注意只支持Get方法
	Url string `json:"url"`
	// Enum Label映射的字段名
	EnumLabelName string `json:"enum_label_name"`
	// Enum Value映射的字段名
	EnumLabelValue string `json:"enum_label_value"`
}

type JOB_STAGE string

type Job struct {
	// 对象Id
	Id string `json:"id" gorm:"column:id;primaryKey"`
	// 创建时间
	CreateAt time.Time `json:"create_at" gorm:"column:create_at"`
	// 更新时间
	UpdateAt *time.Time `json:"update_at" gorm:"column:update_at"`
	// 更新人
	UpdateBy string `json:"update_by" gorm:"column:update_by;type:varchar(60)"`

	// Job定义
	CreateJobRequest
	// Job状态
	JobStatus
}

type JobStatus struct {
	// job创建信息
	Stage JOB_STAGE `json:"stage" gorm:"column:stage;type:varchar(32)"`
	// 发布的版本
	Version string `json:"version" validate:"required" gorm:"column:version;type:varchar(64)"`
	// 发布时间
	ChangeAt int64 `json:"change_at" gorm:"column:change_at"`
	// 发布人
	ChangeBy string `json:"change_by" gorm:"column:change_by;type:varchar(60)"`
	// 发布描述
	ChangeDescribe string `json:"change_describe" gorm:"column:change_describe;type:text"`
}

type PARAM_USAGE_TYPE string

type PARAM_VALUE_TYPE string

type QueryJobRequest struct {
	request.PageRequest
}

type RunJobRequest struct {
	// 任务名称
	TaskName string `json:"task_name" gorm:"column:task_name" validate:"required"`
	// 任务描述
	Description string `json:"description"  gorm:"column:description"`
	// Job名称
	JobName string `json:"job_name" gorm:"job_name" validate:"required"`
	// 设置 Job 失败时的重试次数
	MaxRetry *int32 `json:"max_retry" gorm:"column:max_retry"`
	// 设置 Job 的存活时间（秒），完成后 300 秒自动删除
	TTLSecondsAfterFinished *int32 `json:"ttl_seconds_after_finished" gorm:"column:ttl_seconds_after_finished"`
	// 试运行
	DryRun *bool `json:"dry_run" gorm:"column:dry_run"`
	// 执行器的名称
	RunnerName string `json:"runner_name" gorm:"column:runner_name" validate:"required"`
	// 运行时参数
	RunParams []RunParam `json:"run_params" gorm:"column:run_params"`
	// 标签
	Label map[string]string `json:"label" gorm:"column:label"`
}

type RunParam struct {
	// 可选/必传
	Required bool `json:"required"`
	// 参数使用类型
	UsageType PARAM_USAGE_TYPE `json:"usage_type"`
	// 参数名称
	Name string `json:"name" validate:"required"`
	// 设置了值后，不允许修改, 用于控制流水线模版变量
	ReadOnly bool `json:"read_only"`
	// 参数描述
	NameDesc string `json:"name_desc"`
	// 值类型
	ValueType PARAM_VALUE_TYPE `json:"value_type"`
	// 枚举值的选项
	EnumOptions []*EnumOption `json:"enum_options"`
	// 基于Http枚举的配置
	HttpEnumConfig *HttpEnumConfig `json:"http_enum_config"`
	// 值的样例
	Example string `json:"example"`
	// 默认值, task运行时如果未传人，会填充默认值
	Value string `json:"value"`
	// 有事件触发时 自动注入
	EventInject bool `json:"event_inject"`
	// 值描述
	ValueDesc string `json:"value_desc"`
	// 是否加入到过滤标签中, 方便过滤搜索, 默认不会加入到搜索标签中
	SearchLabel bool `json:"search_label"`
	// 是否是敏感信息, 比如密码之类的, 如果是，显示的时候需要做脱敏处理
	IsSensitive bool `json:"is_sensitive"`
	// 是否废弃
	Deprecate bool `json:"deprecate"`
	// 废弃说明
	DeprecateDesc string `json:"deprecate_desc"`
	// 参数标签
	Lable map[string]string `json:"label"`
	// 扩展属性
	Extensions map[string]string `json:"extensions"`
}

type Service interface {
	// 创建Job
	CreateJob(context.Context, *CreateJobRequest) (*Job, error)
	// 查询Job
	QueryJob(context.Context, *QueryJobRequest) (*types.Set[*Job], error)
	// 获取Job详情
	DescribeJob(context.Context, *DescribeJobRequest) (*Job, error)
	// 删除Job
	DeleteJob(context.Context, *DeleteJobRequest) (*Job, error)
}