Documentation ¶
Index ¶
- Constants
- Variables
- func AddRouter(r chi.Router, router IRouter)
- func RegisterRouters(r *chi.Mux, debugMode bool)
- type ClusterRouter
- type FlavourRouter
- type GrantRouter
- type IRouter
- type JobRouter
- func (jr *JobRouter) AddRouter(r chi.Router)
- func (jr *JobRouter) CreateDistributedJob(w http.ResponseWriter, r *http.Request)
- func (jr *JobRouter) CreateSingleJob(w http.ResponseWriter, r *http.Request)
- func (jr *JobRouter) CreateWorkflowJob(w http.ResponseWriter, r *http.Request)
- func (jr *JobRouter) DeleteJob(w http.ResponseWriter, r *http.Request)
- func (jr *JobRouter) GetJob(writer http.ResponseWriter, request *http.Request)
- func (jr *JobRouter) GetJobByWebsocket(writer http.ResponseWriter, request *http.Request)
- func (jr *JobRouter) ListJob(writer http.ResponseWriter, request *http.Request)
- func (jr *JobRouter) Name() string
- func (jr *JobRouter) StopJob(w http.ResponseWriter, r *http.Request)
- func (jr *JobRouter) UpdateJob(w http.ResponseWriter, r *http.Request)
- type LinkRouter
- type LogRouter
- type PFSRouter
- type PipelineRouter
- type QueueRouter
- type RunRouter
- type ScheduleRouter
- type StatisticsRouter
- type TrackRouter
- type UserRouter
- type VersionRouter
Constants ¶
const FsNameMaxLen = 63
Variables ¶
var FsnamePlusUsernameMaxLen int = 63 - len("fs-") - len("-")
Functions ¶
func RegisterRouters ¶
Types ¶
type ClusterRouter ¶
type ClusterRouter struct{}
func (*ClusterRouter) AddRouter ¶
func (cr *ClusterRouter) AddRouter(r chi.Router)
func (*ClusterRouter) Name ¶
func (cr *ClusterRouter) Name() string
type FlavourRouter ¶
type FlavourRouter struct{}
FlavourRouter is flavour api router
func (*FlavourRouter) AddRouter ¶
func (fr *FlavourRouter) AddRouter(r chi.Router)
AddRouter add flavour router to root router
func (*FlavourRouter) Name ¶
func (fr *FlavourRouter) Name() string
Name indicate name of flavour router
type GrantRouter ¶
type GrantRouter struct { }
func (*GrantRouter) AddRouter ¶
func (gr *GrantRouter) AddRouter(r chi.Router)
func (*GrantRouter) Name ¶
func (gr *GrantRouter) Name() string
type JobRouter ¶
type JobRouter struct{}
JobRouter is job api router
func (*JobRouter) CreateDistributedJob ¶
func (jr *JobRouter) CreateDistributedJob(w http.ResponseWriter, r *http.Request)
CreateDistributedJob create distributed job @Summary 创建Distributed类型作业 @Description 创建Distributed类型作业 @Id createDistributedJob @tags Job @Accept json @Produce json @Success 200 {object} job.CreateJobResponse "创建distributed类型作业的响应" @Failure 400 {object} common.ErrorResponse "400" @Router /job/distributed [POST]
func (*JobRouter) CreateSingleJob ¶
func (jr *JobRouter) CreateSingleJob(w http.ResponseWriter, r *http.Request)
CreateSingleJob create single job @Summary 创建single类型作业 @Description 创建single类型作业 @Id createSingleJob @tags Job @Accept json @Produce json @Success 200 {object} job.CreateJobResponse "创建single类型作业的响应" @Failure 400 {object} common.ErrorResponse "400" @Router /job/single [POST]
func (*JobRouter) CreateWorkflowJob ¶
func (jr *JobRouter) CreateWorkflowJob(w http.ResponseWriter, r *http.Request)
CreateWorkflowJob create workflow job @Summary 创建Workflow类型作业 @Description 创建Workflow类型作业 @Id createWorkflowJob @tags Job @Accept json @Produce json @Success 200 {object} job.CreateJobResponse "创建Workflow类型作业的响应" @Failure 400 {object} common.ErrorResponse "400" @Router /job/workflow [POST]
func (*JobRouter) DeleteJob ¶
func (jr *JobRouter) DeleteJob(w http.ResponseWriter, r *http.Request)
DeleteJob delete job @Summary 删除作业 @Description 删除作业 @Id DeleteJob @tags Job @Accept json @Produce json @Param jobID path string true "作业ID" @Success 200 {string} "删除作业的响应" @Failure 400 {object} common.ErrorResponse "400" @Router /job/{jobID} [DELETE]
func (*JobRouter) GetJob ¶
func (jr *JobRouter) GetJob(writer http.ResponseWriter, request *http.Request)
GetJob @Summary 获取作业详情 @Description 获取作业详情 @Id getJob @tags Job @Accept json @Produce json @Param jobID path string true "作业ID" @Success 200 {object} job.GetJobResponse "作业详情" @Failure 400 {object} common.ErrorResponse "400" @Failure 500 {object} common.ErrorResponse "500" @Router /job/{jobID} [GET]
func (*JobRouter) GetJobByWebsocket ¶
func (jr *JobRouter) GetJobByWebsocket(writer http.ResponseWriter, request *http.Request)
func (*JobRouter) ListJob ¶
func (jr *JobRouter) ListJob(writer http.ResponseWriter, request *http.Request)
ListJob @Summary 获取作业列表 @Description 获取作业列表 @Id listJob @tags Job @Accept json @Produce json @Param status query string false "作业状态过滤" @Param maxKeys query int false "每页包含的最大数量,缺省值为50" @Param marker query string false "批量获取列表的查询的起始位置,是一个由系统生成的字符串" @Success 200 {object} job.ListJobResponse "获取作业列表的响应" @Failure 400 {object} common.ErrorResponse "400" @Failure 500 {object} common.ErrorResponse "500" @Router /job [GET]
func (*JobRouter) StopJob ¶
func (jr *JobRouter) StopJob(w http.ResponseWriter, r *http.Request)
StopJob stop job @Summary 停止作业 @Description 停止作业 @Id StopJob @tags Job @Accept json @Produce json @Param jobID path string true "作业ID" @Success 200 {string} "停止作业的响应" @Failure 400 {object} common.ErrorResponse "400" @Router /job/{jobID}?action=stop [PUT]
func (*JobRouter) UpdateJob ¶
func (jr *JobRouter) UpdateJob(w http.ResponseWriter, r *http.Request)
UpdateJob update job @Summary 更新作业 @Description 更新作业 @Id UpdateJob @tags Job @Accept json @Produce json @Param jobID path string true "作业ID" @Success 200 {string} "更新作业的响应" @Failure 400 {object} common.ErrorResponse "400" @Router /job/{jobID}?action=modify [PUT]
type LinkRouter ¶
type LinkRouter struct{}
func (*LinkRouter) AddRouter ¶
func (lr *LinkRouter) AddRouter(r chi.Router)
func (*LinkRouter) Name ¶
func (lr *LinkRouter) Name() string
type PipelineRouter ¶
type PipelineRouter struct{}
func (*PipelineRouter) AddRouter ¶
func (pr *PipelineRouter) AddRouter(r chi.Router)
func (*PipelineRouter) Name ¶
func (pr *PipelineRouter) Name() string
type QueueRouter ¶
type QueueRouter struct{}
func (*QueueRouter) AddRouter ¶
func (qr *QueueRouter) AddRouter(r chi.Router)
func (*QueueRouter) Name ¶
func (qr *QueueRouter) Name() string
type ScheduleRouter ¶ added in v0.14.3
type ScheduleRouter struct{}
func (*ScheduleRouter) AddRouter ¶ added in v0.14.3
func (sr *ScheduleRouter) AddRouter(r chi.Router)
func (*ScheduleRouter) Name ¶ added in v0.14.3
func (sr *ScheduleRouter) Name() string
type StatisticsRouter ¶ added in v0.14.3
type StatisticsRouter struct{}
func (*StatisticsRouter) AddRouter ¶ added in v0.14.3
func (sr *StatisticsRouter) AddRouter(r chi.Router)
func (*StatisticsRouter) Name ¶ added in v0.14.3
func (sr *StatisticsRouter) Name() string
type TrackRouter ¶
type TrackRouter struct{}
func (*TrackRouter) AddRouter ¶
func (tr *TrackRouter) AddRouter(r chi.Router)
func (*TrackRouter) Name ¶
func (tr *TrackRouter) Name() string
type UserRouter ¶
type UserRouter struct{}
func (*UserRouter) AddRouter ¶
func (ur *UserRouter) AddRouter(r chi.Router)
func (*UserRouter) Name ¶
func (ur *UserRouter) Name() string
type VersionRouter ¶ added in v0.14.5
type VersionRouter struct{}
func (*VersionRouter) AddRouter ¶ added in v0.14.5
func (ur *VersionRouter) AddRouter(r chi.Router)
func (*VersionRouter) Name ¶ added in v0.14.5
func (ur *VersionRouter) Name() string