api

Documentation

Index

• Constants
• func HandleAddJob(cache job.JobCache, defaultOwner string, disableLocalJobs bool) func(http.ResponseWriter, *http.Request)
• func HandleDeleteAllJobs(cache job.JobCache, disableDeleteAll bool) 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 HandleJobParamsRequest(cache job.JobCache) func(w http.ResponseWriter, r *http.Request)
• func HandleJobRequest(cache job.JobCache, disableLocalJobs bool) func(w http.ResponseWriter, r *http.Request)
• func HandleJobRunRequest(cache job.JobCache) func(w http.ResponseWriter, r *http.Request)
• func HandleKalaStatsRequest(cache job.JobCache) func(w http.ResponseWriter, r *http.Request)
• func HandleListJobRunsRequest(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 MakeServer(listenAddr string, cache job.JobCache, defaultOwner string, profile bool, ...) *http.Server
• func SetupApiRoutes(r *mux.Router, cache job.JobCache, defaultOwner string, disableDeleteAll bool, ...)
• type AddJobResponse
• type JobResponse
• type JobRunResponse
• 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, disableLocalJobs bool) 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, disableDeleteAll bool) 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 HandleJobParamsRequest

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

HandleJobParamsRequest handles requests to /api/v1/job/{id}/params to either return the remote job's parameters on a GET or replace them on a PUT. or updates the job if its a PUT request.

func HandleJobRequest

func HandleJobRequest(cache job.JobCache, disableLocalJobs bool) 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 or updates the job if its a PUT request.

func HandleJobRunRequest

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

HandleJobRunRequest is the handler for doing things to a single job run /api/v1/job/{job_id}/executions/{run_id}/

func HandleKalaStatsRequest

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

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

func HandleListJobRunsRequest

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

HandleListJobRunsRequest is the handler listing executions /api/v1/job/{id}/executions

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 MakeServer

func MakeServer(listenAddr string, cache job.JobCache, defaultOwner string, profile bool, disableDeleteAll bool,
	disableLocalJobs bool) *http.Server

func SetupApiRoutes

func SetupApiRoutes(r *mux.Router, cache job.JobCache, defaultOwner string, disableDeleteAll bool,
	disableLocalJobs bool)

SetupApiRoutes is used within main to initialize all of the routes

Types

type AddJobResponse

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

type JobResponse

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

type JobRunResponse

type JobRunResponse struct {
	JobRun *job.JobStat `json:"job_run"`
}

JobRunResponse is for returning a single job execution

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"`
}