Package cn.sliew.carp.module.application.vela.api.v1

Interface PipelineApi

public interface PipelineApi

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<V1Context>	createContextValue(V1CreateContextValuesRequest body, String projectName, String pipelineName)
org.springframework.http.ResponseEntity<V1PipelineBase>	createPipeline(V1CreatePipelineRequest body, String projectName)
org.springframework.http.ResponseEntity<V1ContextNameResponse>	deleteContextValue(String projectName, String pipelineName, String contextName)
org.springframework.http.ResponseEntity<V1PipelineMetaResponse>	deletePipeline(String projectName, String pipelineName)
org.springframework.http.ResponseEntity<V1PipelineRunMeta>	deletePipelineRun(String projectName, String pipelineName, String runName)
org.springframework.http.ResponseEntity<V1GetPipelineResponse>	getPipeline(String pipelineName, String projectName)
org.springframework.http.ResponseEntity<V1PipelineRunBase>	getPipelineRun(String projectName, String pipelineName, String runName)
org.springframework.http.ResponseEntity<V1GetPipelineRunInputResponse>	getPipelineRunInput(String step, String projectName, String pipelineName, String runName)
org.springframework.http.ResponseEntity<V1GetPipelineRunLogResponse>	getPipelineRunLog(String projectName, String pipelineName, String runName, String step)
org.springframework.http.ResponseEntity<V1GetPipelineRunOutputResponse>	getPipelineRunOutput(String step, String projectName, String pipelineName, String runName)
org.springframework.http.ResponseEntity<V1alpha1WorkflowRunStatus>	getPipelineRunStatus(String projectName, String pipelineName, String runName)
org.springframework.http.ResponseEntity<V1ListContextValueResponse>	listContextValues(String projectName, String pipelineName)
org.springframework.http.ResponseEntity<V1ListPipelineRunResponse>	listPipelineRuns(String projectName, String pipelineName, String status)
org.springframework.http.ResponseEntity<V1ListPipelineResponse>	listPipelines(String query, String projectName, Boolean detailed)
org.springframework.http.ResponseEntity<V1EmptyResponse>	resumePipelineRun(String projectName, String pipelineName, String runName, String step)
org.springframework.http.ResponseEntity<V1PipelineRun>	runPipeline(V1RunPipelineRequest body, String projectName, String pipelineName)
org.springframework.http.ResponseEntity<V1PipelineRunMeta>	stopPipeline(String projectName, String pipelineName, String runName)
org.springframework.http.ResponseEntity<V1EmptyResponse>	terminatePipelineRun(String projectName, String pipelineName, String runName)
org.springframework.http.ResponseEntity<V1Context>	updateContextValue(V1UpdateContextValuesRequest body, String projectName, String pipelineName, String contextName)
org.springframework.http.ResponseEntity<V1PipelineBase>	updatePipeline(V1UpdatePipelineRequest body, String projectName, String pipelineName)

Method Details

listContextValues

@GetMapping("/api/v1/projects/{projectName}/pipelines/{pipelineName}/contexts")
org.springframework.http.ResponseEntity<V1ListContextValueResponse> listContextValues(@PathVariable("projectName")
 String projectName,
 @PathVariable("pipelineName")
 String pipelineName)

createContextValue

@PostMapping("/api/v1/projects/{projectName}/pipelines/{pipelineName}/contexts")
org.springframework.http.ResponseEntity<V1Context> createContextValue(@RequestBody
 V1CreateContextValuesRequest body,
 @PathVariable("projectName")
 String projectName,
 @PathVariable("pipelineName")
 String pipelineName)

updateContextValue

@PutMapping("/api/v1/projects/{projectName}/pipelines/{pipelineName}/contexts/{contextName}")
org.springframework.http.ResponseEntity<V1Context> updateContextValue(@RequestBody
 V1UpdateContextValuesRequest body,
 @PathVariable("projectName")
 String projectName,
 @PathVariable("pipelineName")
 String pipelineName,
 @PathVariable("contextName")
 String contextName)

deleteContextValue

@DeleteMapping("/api/v1/projects/{projectName}/pipelines/{pipelineName}/contexts/{contextName}")
org.springframework.http.ResponseEntity<V1ContextNameResponse> deleteContextValue(@PathVariable("projectName")
 String projectName,
 @PathVariable("pipelineName")
 String pipelineName,
 @PathVariable("contextName")
 String contextName)

listPipelines

@GetMapping("/api/v1/pipelines")
org.springframework.http.ResponseEntity<V1ListPipelineResponse> listPipelines(@RequestParam(value="query",required=false)
 String query,
 @RequestParam(value="projectName",required=false)
 String projectName,
 @RequestParam(value="detailed",required=false,defaultValue="true")
 Boolean detailed)

getPipeline

@GetMapping("/api/v1/projects/{projectName}/pipelines/{pipelineName}")
org.springframework.http.ResponseEntity<V1GetPipelineResponse> getPipeline(@PathVariable("pipelineName")
 String pipelineName,
 @PathVariable("projectName")
 String projectName)

createPipeline

@PostMapping("/api/v1/projects/{projectName}/pipelines")
org.springframework.http.ResponseEntity<V1PipelineBase> createPipeline(@RequestBody
 V1CreatePipelineRequest body,
 @PathVariable("projectName")
 String projectName)

updatePipeline

@PutMapping("/api/v1/projects/{projectName}/pipelines/{pipelineName}")
org.springframework.http.ResponseEntity<V1PipelineBase> updatePipeline(@RequestBody
 V1UpdatePipelineRequest body,
 @PathVariable("projectName")
 String projectName,
 @PathVariable("pipelineName")
 String pipelineName)

deletePipeline

@DeleteMapping("/api/v1/projects/{projectName}/pipelines/{pipelineName}")
org.springframework.http.ResponseEntity<V1PipelineMetaResponse> deletePipeline(@PathVariable("projectName")
 String projectName,
 @PathVariable("pipelineName")
 String pipelineName)

listPipelineRuns

@GetMapping("/api/v1/projects/{projectName}/pipelines/{pipelineName}/runs")
org.springframework.http.ResponseEntity<V1ListPipelineRunResponse> listPipelineRuns(@PathVariable("projectName")
 String projectName,
 @PathVariable("pipelineName")
 String pipelineName,
 @RequestParam(value="status",required=false)
 String status)

getPipelineRun

@GetMapping("/api/v1/projects/{projectName}/pipelines/{pipelineName}/runs/{runName}")
org.springframework.http.ResponseEntity<V1PipelineRunBase> getPipelineRun(@PathVariable("projectName")
 String projectName,
 @PathVariable("pipelineName")
 String pipelineName,
 @PathVariable("runName")
 String runName)

getPipelineRunInput

@GetMapping("/api/v1/projects/{projectName}/pipelines/{pipelineName}/runs/{runName}/input")
org.springframework.http.ResponseEntity<V1GetPipelineRunInputResponse> getPipelineRunInput(@RequestParam(value="step",required=true)
 String step,
 @PathVariable("projectName")
 String projectName,
 @PathVariable("pipelineName")
 String pipelineName,
 @PathVariable("runName")
 String runName)

getPipelineRunOutput

@GetMapping("/api/v1/projects/{projectName}/pipelines/{pipelineName}/runs/{runName}/output")
org.springframework.http.ResponseEntity<V1GetPipelineRunOutputResponse> getPipelineRunOutput(@RequestParam(value="step",required=true)
 String step,
 @PathVariable("projectName")
 String projectName,
 @PathVariable("pipelineName")
 String pipelineName,
 @PathVariable("runName")
 String runName)

getPipelineRunLog

@GetMapping("/api/v1/projects/{projectName}/pipelines/{pipelineName}/runs/{runName}/log")
org.springframework.http.ResponseEntity<V1GetPipelineRunLogResponse> getPipelineRunLog(@PathVariable("projectName")
 String projectName,
 @PathVariable("pipelineName")
 String pipelineName,
 @PathVariable("runName")
 String runName,
 @RequestParam(value="step",required=false)
 String step)

getPipelineRunStatus

@GetMapping("/api/v1/projects/{projectName}/pipelines/{pipelineName}/runs/{runName}/status")
org.springframework.http.ResponseEntity<V1alpha1WorkflowRunStatus> getPipelineRunStatus(@PathVariable("projectName")
 String projectName,
 @PathVariable("pipelineName")
 String pipelineName,
 @PathVariable("runName")
 String runName)

runPipeline

@PostMapping("/api/v1/projects/{projectName}/pipelines/{pipelineName}/run")
org.springframework.http.ResponseEntity<V1PipelineRun> runPipeline(@RequestBody
 V1RunPipelineRequest body,
 @PathVariable("projectName")
 String projectName,
 @PathVariable("pipelineName")
 String pipelineName)

stopPipeline

@PostMapping("/api/v1/projects/{projectName}/pipelines/{pipelineName}/runs/{runName}/stop")
org.springframework.http.ResponseEntity<V1PipelineRunMeta> stopPipeline(@PathVariable("projectName")
 String projectName,
 @PathVariable("pipelineName")
 String pipelineName,
 @PathVariable("runName")
 String runName)

resumePipelineRun

@PostMapping("/api/v1/projects/{projectName}/pipelines/{pipelineName}/runs/{runName}/resume")
org.springframework.http.ResponseEntity<V1EmptyResponse> resumePipelineRun(@PathVariable("projectName")
 String projectName,
 @PathVariable("pipelineName")
 String pipelineName,
 @PathVariable("runName")
 String runName,
 @RequestParam(value="step",required=false)
 String step)

terminatePipelineRun

@PostMapping("/api/v1/projects/{projectName}/pipelines/{pipelineName}/runs/{runName}/terminate")
org.springframework.http.ResponseEntity<V1EmptyResponse> terminatePipelineRun(@PathVariable("projectName")
 String projectName,
 @PathVariable("pipelineName")
 String pipelineName,
 @PathVariable("runName")
 String runName)

deletePipelineRun

@DeleteMapping("/api/v1/projects/{projectName}/pipelines/{pipelineName}/runs/{runName}")
org.springframework.http.ResponseEntity<V1PipelineRunMeta> deletePipelineRun(@PathVariable("projectName")
 String projectName,
 @PathVariable("pipelineName")
 String pipelineName,
 @PathVariable("runName")
 String runName)