createWaitDependency

Back to index

Summary

Creates a wait dependency for a stage or task.

projectName

Stringrequired

The name for the project that must be unique among all projects.

pipelineName

Stringoptional

The name of the pipeline.

stageName

Stringoptional

The name of the stage.

allowSkip

Booleanoptional

The flag to indicate if a dependency can be skipped at runtime.

assigneesForSkip

Array<Unknown>optional

A list of assignees who can skip a dependency at runtime.

dependentGateType

Stringoptional

The type of dependent gate.

Possible values: "POST", "PRE"

dependentPipelineName

Stringoptional

The name of the dependent pipeline.

dependentProjectName

Stringoptional

The name of the dependent project.

dependentReleaseName

Stringoptional

The name of the dependent release.

dependentStageName

Stringoptional

The name of the dependent stage.

dependentTaskName

Stringoptional

The name of the dependent task.

gateType

Stringoptional

The type of gate.

Possible values: "POST", "PRE"

releaseName

Stringoptional

The name of the release.

taskName

Stringoptional

The name of the task.

waitDependencyName

Stringoptional

The name of the wait dependency.

waitForTriggeredPipelines

Booleanoptional

The flag to indicate that dependency should be created on all triggered pipelines.

waitForTriggeredReleases

Booleanoptional

The flag to indicate that dependency should be created on all triggered releases.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.createWaitDependency(
  projectName: "test-projectName"
  /* optional arguments */
)▼