validateDeployer

Back to index

Summary

Validates the deployer configuration.

projectName

Stringrequired

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

releaseName

Stringoptional

The name of the release.

stageName

Stringoptional

The name of the stage of a pipeline attached to a release if specified.

applicationName

Stringoptional

The name of the application.

actualParameters

Array<ActualParameter>optional

Actual parameters.

applicationProjectName

Stringoptional

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

deployerConfigurationName

Stringoptional

The name of deployer configuration. If not specified, a system generated GUID is used.

deployerTaskName

Stringoptional

The name of the deployer task defined in the provided stage.

environmentName

Stringoptional

The name of the environment.

environmentProjectName

Stringoptional

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

environmentTemplateName

Stringoptional

The name of the environment template.

environmentTemplateProjectName

Stringoptional

The name of the project containing specified environment template. If not specified, it is defaulted to the environment project name.

insertRollingDeployManualStep

Booleanoptional

True to indicate a manual step to inject after each phase or batch.

processName

Stringoptional

The name of the application process.

rollingDeployEnabled

Booleanoptional

Perform rolling deployment.

rollingDeployManualStepAssignees

Array<Unknown>optional

A list of assignees who receive the notification when rolling deploy iteration completes.

rollingDeployManualStepCondition

Stringoptional

Defines run condition on manual step created during rolling deployment.

Possible values: "always", "failure", "success"

rollingDeployPhases

Array<Unknown>optional

One or more rolling deploy phases to be used for deployment.

rolloutApprovers

Array<Unknown>optional

A list of rollout approvers.

rolloutNotificationEnabled

Booleanoptional

Rollout notification enabled (default is false).

snapshotName

Stringoptional

The name of the snapshot.

validationType

Stringoptional

The type of validation to perform (APPROVER for approver, PARAM for parameter, ENV for environment, ALL for all validations). Defaults to ALL.

Possible values: "ALL", "APPROVER", "ENV", "PARAM"

Usage

Groovy

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

ElectricFlow ef = new ElectricFlow()

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