ApplicationDependency

createApplicationDependency

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.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects.(Required)
applicationName	String	The name of the application.(Required)
applicationDependencyName	String	The name of application dependency. If not specified, a system generated GUID is used.
dependentApplicationName	String	The name of application which this application depends on.
dependentProjectName	String	The name the project containing the dependent application.
dependentSnapshotName	String	The name of snapshot of the dependent application.
effectiveDate	String	The date when this dependency is applicable (for example, 2023-05-15).
snapshotName	String	Name of the snapshot; must be unique within the application.

Argument Name

Type

Description

projectName

String

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

applicationName

String

The name of the application.(Required)

applicationDependencyName

String

The name of application dependency. If not specified, a system generated GUID is used.

dependentApplicationName

String

The name of application which this application depends on.

dependentProjectName

String

The name the project containing the dependent application.

dependentSnapshotName

String

The name of snapshot of the dependent application.

effectiveDate

String

The date when this dependency is applicable (for example, 2023-05-15).

snapshotName

String

Name of the snapshot; must be unique within the application.

Usage

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 */)▼

deleteApplicationDependency

Deletes a dependency between two applications.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects.(Required)
applicationName	String	The name of the application.(Required)
applicationDependencyName	String	The name of application dependency. If not specified, a system generated GUID is used.
dependentApplicationName	String	The name of application which this application depends on.
dependentProjectName	String	The name the project containing the dependent application.
dependentSnapshotName	String	The name of snapshot of the dependent application.
snapshotName	String	Name of the snapshot; must be unique within the application.

Argument Name

Type

Description

projectName

String

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

applicationName

String

The name of the application.(Required)

applicationDependencyName

String

The name of application dependency. If not specified, a system generated GUID is used.

dependentApplicationName

String

The name of application which this application depends on.

dependentProjectName

String

The name the project containing the dependent application.

dependentSnapshotName

String

The name of snapshot of the dependent application.

snapshotName

String

Name of the snapshot; must be unique within the application.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

modifyApplicationDependency

Modifies a dependency between two applications.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects.(Required)
applicationName	String	The name of the application.(Required)
applicationDependencyName	String	The name of application dependency. If not specified, a system generated GUID is used.
dependentApplicationName	String	The name of application which this application depends on.
dependentProjectName	String	The name the project containing the dependent application.
dependentSnapshotName	String	The name of snapshot of the dependent application.
effectiveDate	String	The date when this dependency is applicable (for example, 2023-05-15).
newName	String	The new name for an existing object that is being renamed.
snapshotName	String	Name of the snapshot; must be unique within the application.

Argument Name

Type

Description

projectName

String

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

applicationName

String

The name of the application.(Required)

applicationDependencyName

String

The name of application dependency. If not specified, a system generated GUID is used.

dependentApplicationName

String

The name of application which this application depends on.

dependentProjectName

String

The name the project containing the dependent application.

dependentSnapshotName

String

The name of snapshot of the dependent application.

effectiveDate

String

The date when this dependency is applicable (for example, 2023-05-15).

newName

String

The new name for an existing object that is being renamed.

snapshotName

String

Name of the snapshot; must be unique within the application.

Usage

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


ElectricFlow ef = new ElectricFlow()

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