runner

Documentation

Index

• Constants
• func CreateRunner(ctx *gin.Context)
• func DeleteRunner(ctx *gin.Context)
• func FindRunner(ctx *gin.Context)
• func ListRunnerJobs(ctx *gin.Context)
• func ListRunners(ctx *gin.Context)
• func UpdateJobState(ctx *gin.Context)
• func UpdateRunnerMetadata(ctx *gin.Context)

Constants

const LONG_POLL_INTERVAL = 50 * time.Millisecond

const LONG_POLL_TIMEOUT = 1 * time.Minute

Functions

func CreateRunner

func CreateRunner(ctx *gin.Context)

CreateRunner godoc

@Tags			runner
@Summary		Create a runner
@Description	Create a runner
@Param			runner	body	CreateRunnerDTO	true	"Runner"
@Produce		json
@Success		200	{object}	CreateRunnerResultDTO
@Router			/runner [post]

@id				CreateRunner

func DeleteRunner

func DeleteRunner(ctx *gin.Context)

DeleteRunner godoc

@Tags			runner
@Summary		Delete runner
@Description	Delete runner
@Param			runnerId	path	string	true	"Runner ID"
@Success		200
@Router			/runner/{runnerId} [delete]

@id				DeleteRunner

func FindRunner

func FindRunner(ctx *gin.Context)

FindRunner godoc

@Tags			runner
@Summary		Find a runner
@Description	Find a runner
@Param			runnerId	path	string	true	"Runner ID"
@Produce		json
@Success		200	{object}	RunnerDTO
@Router			/runner/{runnerId} [get]

@id				FindRunner

func ListRunnerJobs

func ListRunnerJobs(ctx *gin.Context)

ListRunnerJobs godoc

@Tags			runner
@Summary		List runner jobs
@Description	List runner jobs
@Param			runnerId	path	string	true	"Runner ID"
@Produce		json
@Success		200	{array}	Job
@Router			/runner/{runnerId}/jobs [get]

@id				ListRunnerJobs

func ListRunners

func ListRunners(ctx *gin.Context)

ListRunners godoc

@Tags			runner
@Summary		List runners
@Description	List runners
@Produce		json
@Success		200	{array}	RunnerDTO
@Router			/runner [get]

@id				ListRunners

func UpdateJobState

func UpdateJobState(ctx *gin.Context)

UpdateJobState godoc

@Tags			runner
@Summary		Update job state
@Description	Update job state
@Param			runnerId		path	string			true	"Runner ID"
@Param			jobId			path	string			true	"Job ID"
@Param			updateJobState	body	UpdateJobState	true	"Update job state"
@Produce		json
@Success		200
@Router			/runner/{runnerId}/jobs/{jobId}/state [post]

@id				UpdateJobState

func UpdateRunnerMetadata

func UpdateRunnerMetadata(ctx *gin.Context)

UpdateRunnerMetadata godoc

@Tags			runner
@Summary		Update runner metadata
@Description	Update runner metadata
@Param			runnerId		path	string					true	"Runner ID"
@Param			runnerMetadata	body	UpdateRunnerMetadataDTO	true	"Runner Metadata"
@Success		200
@Router			/runner/{runnerId}/metadata [post]

@id				UpdateRunnerMetadata