Flow API guide
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
Perl API Commands
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
Groovy API guide
IntroductionExamples
Groovy API commands
Introductionaclaclentryactualparameteractualparametersappdepapplicationappservicemappingapptierarchiveconnectorartifactartifactversioncatalogcatalogitemclustercomponentcontainercredentialdashboarddashboardcolumndataretentiondeployerappdeployerconfdeployerservicedeployhistorydirproviderdoisdatasourceemailconfigemailnotifierentitychangeenvinvenvironmentenvmapenvtemeplateenvtemptierenvtemptiermapenvtemptiermappingenvtemptierresourcemappingenvtierenvvareventsubflowruntimeformaloutparamformalparamgategatewaygrouphookjobjobstepkerberoskeytablicensenoteobjectoutputparampersonapersonacatpersonapagepipelinepipelinerunnamepluginportprocdependprocedureprocessprocstepprojectpropertyreleasereportreportfilterreportobjassocreportobjattrreportobjtyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartrollingrundiscoverysamlidentitysamlserviceschedulesearchfilterserverserviceserviceacctserviceclusterservicedepservicemapsessionsnapshotstagestatestatedeftagtasktiermaptiermappingtransdeftransitionuserutilitywaitdependwidgetwidgetfilteroverrideworkdefworkflowworkitemworkspacezone
Groovy API argument models

DeployerConfiguration commands

6 minute readReference

createDeployerConfiguration

Adds deployer configuration to the deployer application or deployer service.

Arguments

Argument NameTypeDescription

projectName

String

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

releaseName

String

The name of the release

serviceName

String

The name of the service

actualParameters

actualParameter array

Actual parameters

applicationName

String

The name of the application

applicationProjectName

String

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

deployerConfigurationName

String

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

deployerTaskName

String

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

environmentName

String

The name of the environment.

environmentProjectName

String

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

environmentTemplateName

String

The name of the environment template.

environmentTemplateProjectName

String

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

insertRollingDeployManualStep

Boolean

True to indicate a manual step needs to be injected after each phase or batch.

processName

String

The name of the application or service process.

rollingDeployEnabled

Boolean

Perform rolling deployment.

rollingDeployManualStepAssignees

String array

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

rollingDeployManualStepCondition

String

Defines run condition on manual step created during rolling deployment.

rollingDeployPhases

String array

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

serviceProjectName

String

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

skipDeploy

Boolean

True to skip deployment to an environment

snapshotName

String

The name of the snapshot

stageName

String

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

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getDeployerConfiguration

Get a deployer configuration

Arguments

Argument NameTypeDescription

projectName

String

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

releaseName

String

The name of the release

stageName

String

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

serviceName

String

The name of the service

applicationName

String

The name of the application

applicationProjectName

String

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

deployerConfigurationName

String

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

deployerTaskName

String

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

serviceProjectName

String

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

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getDeployerConfigurations

Gets all the configurations in the deployer

Arguments

Argument NameTypeDescription

projectName

String

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

releaseName

String

The name of the release

stageName

String

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

applicationName

String

The name of the application

applicationProjectName

String

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

serviceName

String

The name of the service

serviceProjectName

String

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

Usage

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


ElectricFlow ef = new ElectricFlow()

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

modifyDeployerConfiguration

Modifies deployer configuration associated with a deployer application or deployer service.

Arguments

Argument NameTypeDescription

projectName

String

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

releaseName

String

The name of the release

serviceName

String

The name of the service

stageName

String

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

actualParameters

actualParameter array

Actual parameters

applicationName

String

The name of the application

applicationProjectName

String

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

clearActualParameters

Boolean

True if the task should remove all actual parameters.

deployerConfigurationName

String

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

deployerTaskName

String

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

environmentName

String

The name of the environment.

environmentProjectName

String

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

environmentTemplateName

String

The name of the environment template.

environmentTemplateProjectName

String

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

insertRollingDeployManualStep

Boolean

True to indicate a manual step needs to be injected after each phase or batch.

newName

String

New name for an existing object that is being renamed.

processName

String

The name of the application or service process.

rollingDeployEnabled

Boolean

Perform rolling deployment.

rollingDeployManualStepAssignees

String array

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

rollingDeployManualStepCondition

String

Defines run condition on manual step created during rolling deployment.

rollingDeployPhases

String array

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

serviceProjectName

String

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

skipDeploy

Boolean

True to skip deployment to an environment

snapshotName

String

The name of the snapshot

Usage

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


ElectricFlow ef = new ElectricFlow()

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

removeDeployerConfiguration

Removes a deployer configuration

Arguments

Argument NameTypeDescription

projectName

String

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

releaseName

String

The name of the release

stageName

String

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

applicationName

String

The name of the application

applicationProjectName

String

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

deployerConfigurationName

String

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

deployerTaskName

String

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

serviceName

String

The name of the service

serviceProjectName

String

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

Usage

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


ElectricFlow ef = new ElectricFlow()

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

validateDeployer

Validate deployer configuration

Arguments

Argument NameTypeDescription

projectName

String

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

releaseName

String

The name of the release

stageName

String

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

serviceName

String

The name of the service

actualParameters

actualParameter array

Actual parameters

applicationName

String

The name of the application

applicationProjectName

String

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

deployerConfigurationName

String

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

deployerTaskName

String

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

environmentName

String

The name of the environment.

environmentProjectName

String

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

environmentTemplateName

String

The name of the environment template.

environmentTemplateProjectName

String

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

insertRollingDeployManualStep

Boolean

True to indicate a manual step needs to be injected after each phase or batch.

processName

String

The name of the application or service process.

rollingDeployEnabled

Boolean

Perform rolling deployment.

rollingDeployManualStepAssignees

String array

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

rollingDeployManualStepCondition

String

Defines run condition on manual step created during rolling deployment.

rollingDeployPhases

String array

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

serviceProjectName

String

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

snapshotName

String

The name of the snapshot

validationType

String

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

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.validateDeployer(
                projectName: 'test-projectName',
                /* optional arguments */)
deployerapp
deployerservice