createApplicationDependency

On this page
Back to index

Summary

Defines a dependency of an application (or its snapshot) on another application (or snapshot). At runtime, the deployment process checks for the dependent applications on the environment. The deployment stops if dependent applications or their versions are not present and you have requested enforcement of the dependency check. Otherwise, the deployment continues with a warning.
projectName
Stringrequired
The name for the project that must be unique among all projects.
applicationName
Stringrequired
The name of the application.
applicationDependencyName
Stringoptional
The name of application dependency. If not specified, a system generated GUID is used.
dependentApplicationName
Stringoptional
The name of application which this application depends on.
dependentProjectName
Stringoptional
The name the project containing the dependent application.
dependentSnapshotName
Stringoptional
The name of snapshot of the dependent application.
effectiveDate
Stringoptional
The date when this dependency is applicable (for example, 2023-05-15).
snapshotName
Stringoptional
Name of the snapshot; must be unique within the application.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.createApplicationDependency( projectName: "test-projectName", applicationName: "test-applicationName" /* optional arguments */ )