IntroductionRoadmap to CloudBees Flow APIsUsing the CloudBees Flow Perl APICloudBees Flow Perl API Response and Element GlossaryUsing the CloudBees Flow RESTful APIUsing the Flow DSLUsing the CloudBees Flow Groovy APIUsing JRubyCloudBees Flow Error MessagesCloudBees Flow Perl API Response and Element Glossary
IntroductionACL ManagementApplication DependencyApplicationsApplication Tier Artifact ManagementCatalogsChange HistoryComponentsCredential ManagementCustom FiltersDatabase ConfigurationData RetentionDevOps InsightDirectory Provider ManagementDynamic EnvironmentsEmail Configuration ManagementEmail Notifier ManagementEnvironmentEnvironment TierGateway and Zone ManagementInstalling or Upgrading Remote AgentsJob ManagementMicroservicesObject TagsParameter ManagementPersonasPipelines and ReleasesPlugin ManagementProcedure ManagementProcessProcess DependencyProcess StepProject ManagementProperty ManagementResource ManagementRolling DeploySchedule ManagementServer ManagementSingle Sign-OnSnapshotsTier MapUser and Group ManagementWait DependenciesWebhhook ManagementWorkflow Definition ManagementWorkflow ManagementWork ItemsWorkspace ManagementMiscellaneous Management
IntroductionExamples
Introductionaclaclentryactualparameteractualparametersappdepapplicationappservicemappingapptierarchiveconnectorartifactartifactversioncatalogcatalogitemclustercomponentcontainercredentialdashboarddashboardcolumndataretentiondeployerappdeployerconfdeployerservicedeployhistorydirproviderdoisdatasourceemailconfigemailnotifierentitychangeenvinvenvironmentenvmapenvtemeplateenvtemptierenvtemptiermapenvtemptiermappingenvtemptierresourcemappingenvtierenvvareventsubflowruntimeformaloutparamformalparamgategatewaygrouphookjobjobstepkerberoskeytablicensenoteobjectoutputparampersonapersonacatpersonapagepipelinepipelinerunnamepluginportprocdependprocedureprocessprocstepprojectpropertyreleasereportreportfilterreportobjassocreportobjattrreportobjtyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartrollingrundiscoverysamlidentitysamlserviceschedulesearchfilterserverserviceserviceacctserviceclusterservicedepservicemapsessionsnapshotstagestatestatedeftagtasktiermaptiermappingtransdeftransitionuserutilitywaitdependwidgetwidgetfilteroverrideworkdefworkflowworkitemworkspacezone
Groovy API argument models

WaitDependency commands

3 minute readReference

createWaitDependency

Create a wait dependency for a stage or task

Arguments

Argument Name Type Description

projectName

String

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

pipelineName

String

The name of the pipeline

stageName

String

The name of the stage

allowSkip

Boolean

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

assigneesForSkip

String array

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

dependentGateType

String

The type of dependent gate.

dependentPipelineName

String

The name of the dependent pipeline

dependentProjectName

String

The name of the dependent project

dependentReleaseName

String

The name of the dependent release

dependentStageName

String

The name of the dependent stage

dependentTaskName

String

The name of the dependent task

gateType

String

The type of gate.

releaseName

String

The name of the release

taskName

String

The name of the task

waitDependencyName

String

The name of the wait dependency.

waitForTriggeredPipelines

Boolean

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

waitForTriggeredReleases

Boolean

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.apis.model.*


ElectricFlow ef = new ElectricFlow()

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

deleteWaitDependency

Create an WaitDependency for a stage or task

Arguments

Argument Name Type Description

projectName

String

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

pipelineName

String

The name of the pipeline

stageName

String

The name of the stage

waitDependencyName

String

The name of the wait dependency.

dependentGateType

String

The type of dependent gate.

dependentPipelineName

String

The name of the dependent pipeline

dependentProjectName

String

The name of the dependent project

dependentReleaseName

String

The name of the dependent release

dependentStageName

String

The name of the dependent stage

dependentTaskName

String

The name of the dependent task

gateType

String

The type of gate.

releaseName

String

The name of the release

taskName

String

The name of the task

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteWaitDependency(
                projectName: 'test-projectName',
                /* optional arguments */)
▼

getWaitDependency

Get a wait dependency for a stage or task

Arguments

Argument Name Type Description

projectName

String

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

pipelineName

String

The name of the pipeline

stageName

String

The name of the stage

waitDependencyName

String

The name of the wait dependency.

dependentGateType

String

The type of dependent gate.

dependentPipelineName

String

The name of the dependent pipeline

dependentProjectName

String

The name of the dependent project

dependentReleaseName

String

The name of the dependent release

dependentStageName

String

The name of the dependent stage

dependentTaskName

String

The name of the dependent task

gateType

String

The type of gate.

releaseName

String

The name of the release

taskName

String

The name of the task

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getWaitDependency(
                projectName: 'test-projectName',
                /* optional arguments */)
▼

modifyWaitDependency

Modify a wait dependency for a stage or task

Arguments

Argument Name Type Description

projectName

String

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

pipelineName

String

The name of the pipeline

stageName

String

The name of the stage

waitDependencyName

String

The name of the wait dependency.

allowSkip

Boolean

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

assigneesForSkip

String array

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

dependentGateType

String

The type of dependent gate.

dependentPipelineName

String

The name of the dependent pipeline

dependentProjectName

String

The name of the dependent project

dependentReleaseName

String

The name of the dependent release

dependentStageName

String

The name of the dependent stage

dependentTaskName

String

The name of the dependent task

gateType

String

The type of gate.

newName

String

New name for an existing object that is being renamed.

releaseName

String

The name of the release

taskName

String

The name of the task

waitForTriggeredPipelines

Boolean

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

waitForTriggeredReleases

Boolean

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.apis.model.*


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyWaitDependency(
                projectName: 'test-projectName',
                /* optional arguments */)
▼
utility
widget