abortPipelineRun

Back to index

Summary

Aborts a pipeline run.

When using abortPipelineRun with ec-groovy, the flowRuntimeId value is required. For more information, refer to the Examples below.

flowRuntimeId
Stringoptional
The ID of the flow runtime.
flowRuntimeName
Stringoptional
The name of the flow runtime.
force
Booleanoptional
If true running tasks are force aborted.
projectName
Stringoptional
The name of the project.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.abortPipelineRun( /* optional arguments */ )

Example

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.abortPipelineRun(flowRuntimeId: "ef9dc8c6-7104-f16a-9578-687a6484a35a")