Using the Perl API
Perl API reference
IntroductionAccess tokensACL managementApplication dependencyApplicationsApplication tier Artifact managementCatalogsChange historyCI build detailCI configurationCI jobsComponentsCredential managementCustom filtersDatabase configurationData retentionCloudBees AnalyticsDirectory provider managementDynamic environmentsEmail configuration managementEmail notifier managementEnvironmentEnvironment tierGateway and zone managementInstalling or upgrading remote agentsJob managementMicroservicesObject tagsParameter managementPersonasPipelines and releasesPlugin managementPlugin configuration managementProcedure managementProcessProcess dependencyProcess stepProject managementProperty managementResource managementRolling deploySchedule managementService accounts for webhooksServer managementSingle sign on for SAMLSnapshotsTier mapTrigger managementUser and group managementUser profile email managementWait dependenciesWorkflow definition managementWorkflow managementWork itemsWorkspace managementMiscellaneous management
Perl API response and element glossary
Using the Groovy API
IntroductionExamplesTroubleshooting
Groovy API reference
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

EnvironmentTier

4 minute readReference

addResourcePoolToEnvironmentTier

Adds the given resource pool to the given environment tier.

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. (Required)

environmentTierName

String

Name for the environment tier; must be unique among all tiers for the environment. (Required)

resourcePoolName

String

Name for the resource pool; must be unique among all resource pools. (Required)

rollingDeployPhaseName

String

Name for the rolling deploy phase to be associated with the resource pool.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.addResourcePoolToEnvironmentTier(
                projectName: 'test-projectName',
                environmentName: 'test-environmentName',
                environmentTierName: 'test-environmentTierName',
                resourcePoolName: 'test-resourcePoolName'
                /* optional arguments */)

addResourceToEnvironmentTier

Adds the given resource to the given environment tier.

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. (Required)

environmentTierName

String

Name for the environment tier; must be unique among all tiers for the environment. (Required)

resourceName

String

Name for the resource; must be unique among all resources. (Required)

rollingDeployPhaseName

String

Name for the rolling deploy phase to be associated with the resource.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.addResourceToEnvironmentTier(
                projectName: 'test-projectName',
                environmentName: 'test-environmentName',
                environmentTierName: 'test-environmentTierName',
                resourceName: 'test-resourceName'
                /* optional arguments */)

addResourcesToEnvironmentTier

Adds the given resources to the given environment tier.

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. (Required)

environmentTierName

String

Name for the environment tier; must be unique among all tiers for the environment. (Required)

resourceNames

String array

List of resources to add to the environment tier.

resourcePhaseMappings

ResourcePhaseMapping array

A map of resource and rolling deploy phase

Usage

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


ElectricFlow ef = new ElectricFlow()

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

createEnvironmentTier

Create a new environment tier.

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. (Required)

environmentTierName

String

Name for the environment tier; must be unique among all tiers for the environment. (Required)

batchSize

String

The size of the batch supported by the environment tier.

batchSizeType

String

The type of batch size supported by the environment tier.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

resourceNames

String array

List of resources to add to the environment tier.

resourcePhaseMappings

ResourcePhaseMapping array

A map of resource and rolling deploy phase

resourcePoolNames

String array

List of resource pools to add to the environment tier.

resourcePoolPhaseMappings

array

A map of resource pool and rolling deploy phase

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deleteEnvironmentTier

Deletes an environment tier.

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. (Required)

environmentTierName

String

Name for the environment tier; must be unique among all tiers for the environment. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteEnvironmentTier(
                projectName: 'test-projectName',
                environmentName: 'test-environmentName',
                environmentTierName: 'test-environmentTierName')

getEnvironmentTier

Retrieve an environment tier by name.

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. (Required)

environmentTierName

String

Name for the environment tier; must be unique among all tiers for the environment. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getEnvironmentTier(
                projectName: 'test-projectName',
                environmentName: 'test-environmentName',
                environmentTierName: 'test-environmentTierName')

getEnvironmentTiers

Retrieve all environment tiers in an 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. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getEnvironmentTiers(
                projectName: 'test-projectName',
                environmentName: 'test-environmentName')

modifyEnvironmentTier

Modify an environment tier.

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. (Required)

environmentTierName

String

Name for the environment tier; must be unique among all tiers for the environment. (Required)

batchSize

String

The size of the batch supported by the environment tier.

batchSizeType

String

The type of batch size supported by the environment tier.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

newName

String

New name for an existing object that is being renamed.

resourceNames

String array

List of resources to add to the environment tier.

resourcePhaseMappings

ResourcePhaseMapping array

A map of resource and rolling deploy phase

resourcePoolNames

String array

List of resource pools to add to the environment tier.

resourcePoolPhaseMappings

array

A map of resource pool and rolling deploy phase

Usage

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


ElectricFlow ef = new ElectricFlow()

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

setTierResourcePhase

Maps a given resource to a rolling deploy phase.

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. (Required)

environmentTierName

String

Name for the environment tier; must be unique among all tiers for the environment. (Required)

resourceNames

String array

List of resources to be mapped to a rolling deploy phase

resourcePhaseMappings

ResourcePhaseMapping array

A map of resource and rolling deploy phase

resourcePoolNames

String array

List of resource pools to be mapped to a rolling deploy phase

resourcePoolPhaseMappings

array

A map of resource pool and rolling deploy phase

rollingDeployPhaseName

String

Name for the rolling deploy phase to be associated with the resource.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.setTierResourcePhase(
                projectName: 'test-projectName',
                environmentName: 'test-environmentName',
                environmentTierName: 'test-environmentTierName'
                /* optional arguments */)
environmenttemplatetiermapping
envtempltierresourcetemplmapping