modifyDeployerApplication

Back to index

Summary

Modifies the deployer application associated with a release.

projectName

Stringrequired

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

releaseName

Stringoptional

The name of the release.

applicationName

Stringrequired

The name of the application.

afterDeployerApplication

Stringoptional

The name of the deployer application after which this deployer application should be placed.

afterLastRetry

Stringoptional

Specify continue or stop pipeline execution after last unsuccessful retry or a task.

Possible values: "continueOnError", "stopOnError"

applicationProjectName

Stringoptional

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

beforeDeployerApplication

Stringoptional

The name of the deployer application before which this deployer application should be placed.

enforceDependencies

Booleanoptional

Enforce dependencies flag to be used during runProcess for the application.

errorHandling

Stringoptional

Specifies error handling for the deployer application.

Possible values: "continueOnError", "retryOnError", "stopOnError"

orderIndex

Integeroptional

Specifies the application deployment order (starts from 1).

processName

Stringoptional

The name of the application process.

retryApprovers

Array<Unknown>optional

A list of retry approvers who receive the notification.

retryCount

Stringoptional

If the retry is auto, specify the maximum number of times retry should occur.

retryInterval

Stringoptional

If the retry is auto, specify the number of seconds to wait until the next retry should occur.

retryNotificationTemplate

Stringoptional

Email retry notification template for application.

retryType

Stringoptional

Type of retry when process step or task fails. Is one of auto or manual.

Possible values: "auto", "manual"

smartDeploy

Booleanoptional

Smart deploy flag to be used during runProcess for the application.

snapshotName

Stringoptional

The name of the snapshot.

stageArtifacts

Booleanoptional

Stage artifacts for the application process.

Usage

Groovy

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

ElectricFlow ef = new ElectricFlow()

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