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
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
IntroductionExamples
Introductionaclaclentryactualparameteractualparametersappdepapplicationappservicemappingapptierarchiveconnectorartifactartifactversioncatalogcatalogitemclustercomponentcontainercredentialdashboarddashboardcolumndataretentiondeployerappdeployerconfdeployerservicedeployhistorydirproviderdoisdatasourceemailconfigemailnotifierentitychangeenvinvenvironmentenvmapenvtemeplateenvtemptierenvtemptiermapenvtemptiermappingenvtemptierresourcemappingenvtierenvvareventsubflowruntimeformaloutparamformalparamgategatewaygrouphookjobjobstepkerberoskeytablicensenoteobjectoutputparampersonapersonacatpersonapagepipelinepipelinerunnamepluginportprocdependprocedureprocessprocstepprojectpropertyreleasereportreportfilterreportobjassocreportobjattrreportobjtyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartrollingrundiscoverysamlidentitysamlserviceschedulesearchfilterserverserviceserviceacctserviceclusterservicedepservicemapsessionsnapshotstagestatestatedeftagtasktiermaptiermappingtransdeftransitionuserutilitywaitdependwidgetwidgetfilteroverrideworkdefworkflowworkitemworkspacezone
Groovy API argument models

RollingDeployPhase commands

3 minute readReference

createRollingDeployPhase

Adds rolling deploy phase to the specified environment.

Arguments

Argument Name Type Description

projectName

String

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

rollingDeployPhaseName

String

The name of the rolling deploy phase (Required)

environmentName

String

The name of the environment

description

String

Comment text describing this object that is not interpreted at all by CloudBees Flow.

orderIndex

Integer

Specifies the phase order (starts from 1).

phaseExpression

String

A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a "0" or "false" is interpreted as FALSE. Any other result string is interpreted as TRUE.

rollingDeployPhaseType

String

The type of rolling deploy phase.

Usage

Groovy

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


ElectricFlow ef = new ElectricFlow()

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

getRollingDeployPhase

Get the rolling deploy phase in the environment by name

Arguments

Argument Name Type Description

projectName

String

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

rollingDeployPhaseName

String

The name of the rolling deploy phase (Required)

environmentName

String

The name of the environment

environmentTierName

String

Name for the environment tier.

includeResourceCount

Boolean

True to include resource count for rolling deploy phase.

Usage

Groovy

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


ElectricFlow ef = new ElectricFlow()

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

getRollingDeployPhases

Gets all the rolling deploy phases in the environment

Arguments

Argument Name Type Description

projectName

String

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

environmentName

String

The name of the environment

applicationName

String

Name for the application.

applicationProjectName

String

Name for the application project.

environmentTierName

String

Name for the environment tier.

includeResourceCount

Boolean

True to include resource count for rolling deploy phase.

Usage

Groovy

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


ElectricFlow ef = new ElectricFlow()

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

modifyRollingDeployPhase

Modifies rolling deploy phase associated with an environment.

Arguments

Argument Name Type Description

projectName

String

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

rollingDeployPhaseName

String

The name of the rolling deploy phase (Required)

environmentName

String

The name of the environment

description

String

Comment text describing this object that is not interpreted at all by CloudBees Flow.

newName

String

New name for an existing object that is being renamed.

orderIndex

Integer

Specifies the phase order (starts from 1).

phaseExpression

String

A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a "0" or "false" is interpreted as FALSE. Any other result string is interpreted as TRUE.

rollingDeployPhaseType

String

The type of rolling deploy phase.

Usage

Groovy

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


ElectricFlow ef = new ElectricFlow()

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

RunDiscovery

runDiscovery

Run a plugin’s Discover procedure to discover contents of a list or set of resources and store settings for them in the ec_discovery property sheets.

Arguments

Argument Name Type Description

resourceName

String array

List of resources to use for discovery.

configurationName

String

The name of the plugin configuration.

environmentName

String

The name of the environment.

environmentTierName

String

The name of the environment tier.

pluginKey

String

Version independent name of the plugin.

pluginName

String

The name of the plugin.

projectName

String

The name of the project.

Usage

Groovy

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


ElectricFlow ef = new ElectricFlow()

def result = ef.runDiscovery(
                /* optional arguments */)
▼
retrievedart
rundiscovery