api

Documentation

Index

• Constants
• func HandleAddJob(cache job.JobCache, defaultOwner string) func(http.ResponseWriter, *http.Request)
• func HandleDeleteAllJobs(cache job.JobCache, db job.JobDB) func(w http.ResponseWriter, r *http.Request)
• func HandleDisableJobRequest(cache job.JobCache) func(w http.ResponseWriter, r *http.Request)
• func HandleEnableJobRequest(cache job.JobCache) func(w http.ResponseWriter, r *http.Request)
• func HandleJobRequest(cache job.JobCache, db job.JobDB) func(w http.ResponseWriter, r *http.Request)
• func HandleKalaStatsRequest(cache job.JobCache) func(w http.ResponseWriter, r *http.Request)
• func HandleListJobStatsRequest(cache job.JobCache) func(w http.ResponseWriter, r *http.Request)
• func HandleListJobsRequest(cache job.JobCache) func(w http.ResponseWriter, r *http.Request)
• func HandleStartJobRequest(cache job.JobCache) func(w http.ResponseWriter, r *http.Request)
• func SetupApiRoutes(r *mux.Router, cache job.JobCache, db job.JobDB, defaultOwner string)
• func StartServer(listenAddr string, cache job.JobCache, db job.JobDB, defaultOwner string) error
• type AddJobResponse
• type JobResponse
• type KalaStatsResponse
• type ListJobStatsResponse
• type ListJobsResponse

Constants

const (
	// Base API v1 Path
	ApiUrlPrefix = "/api/v1/"

	JobPath    = "job/"
	ApiJobPath = ApiUrlPrefix + JobPath
)

Functions

func HandleAddJob

func HandleAddJob(cache job.JobCache, defaultOwner string) func(http.ResponseWriter, *http.Request)

HandleAddJob takes a job object and unmarshals it to a Job type, and then throws the job in the schedulers.

func HandleDeleteAllJobs

func HandleDeleteAllJobs(cache job.JobCache, db job.JobDB) func(w http.ResponseWriter, r *http.Request)

HandleDeleteAllJobs is the handler for deleting all jobs DELETE /api/v1/job/all

func HandleDisableJobRequest

func HandleDisableJobRequest(cache job.JobCache) func(w http.ResponseWriter, r *http.Request)

HandleDisableJobRequest is the handler for mdisabling jobs /api/v1/job/disable/{id}

func HandleEnableJobRequest

func HandleEnableJobRequest(cache job.JobCache) func(w http.ResponseWriter, r *http.Request)

HandleEnableJobRequest is the handler for enable jobs /api/v1/job/enable/{id}

func HandleJobRequest

func HandleJobRequest(cache job.JobCache, db job.JobDB) func(w http.ResponseWriter, r *http.Request)

HandleJobRequest routes requests to /api/v1/job/{id} to either handleDeleteJob if its a DELETE or handleGetJob if its a GET request.

func HandleKalaStatsRequest

func HandleKalaStatsRequest(cache job.JobCache) func(w http.ResponseWriter, r *http.Request)

HandleKalaStatsRequest is the hanlder for getting system-level metrics /api/v1/stats

func HandleListJobStatsRequest

func HandleListJobStatsRequest(cache job.JobCache) func(w http.ResponseWriter, r *http.Request)

HandleListJobStatsRequest is the handler for getting job-specific stats /api/v1/job/stats/{id}

func HandleListJobsRequest

func HandleListJobsRequest(cache job.JobCache) func(w http.ResponseWriter, r *http.Request)

HandleListJobs responds with an array of all Jobs within the server, active or disabled.

func HandleStartJobRequest

func HandleStartJobRequest(cache job.JobCache) func(w http.ResponseWriter, r *http.Request)

HandleStartJobRequest is the handler for manually starting jobs /api/v1/job/start/{id}

func SetupApiRoutes

func SetupApiRoutes(r *mux.Router, cache job.JobCache, db job.JobDB, defaultOwner string)

SetupApiRoutes is used within main to initialize all of the routes

func StartServer

func StartServer(listenAddr string, cache job.JobCache, db job.JobDB, defaultOwner string) error

Types

type AddJobResponse

type AddJobResponse struct {
	Id string `json:"id"`
}

type JobResponse

type JobResponse struct {
	Job *job.Job `json:"job"`
}

type KalaStatsResponse

type KalaStatsResponse struct {
	Stats *job.KalaStats
}

type ListJobStatsResponse

type ListJobStatsResponse struct {
	JobStats []*job.JobStat `json:"job_stats"`
}

type ListJobsResponse

type ListJobsResponse struct {
	Jobs map[string]*job.Job `json:"jobs"`
}