abortPipelineRun

Back to index

Summary

Aborts a pipeline run.

request

Stringrequired

This parameter and the value displayed are required; request=abortPipelineRun must appear in your query string.

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(
  request: "test-request"
  /* optional arguments */
)▼