Introduction
Using JRuby
API error messages
API command line access
Using DSL
IntroductionGetting started with DSLGenerating DSL scriptsDSL automation as codeDSL editorsTroubleshooting and FAQs
DSL method reference
Using the RESTful API
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 managementGet application environment inventoryInstalling 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

TierMapping

2 minute readReference

createTierMapping

Creates a new tier mapping for a tierMap.

Arguments

Argument NameTypeDescription

projectName

String

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

applicationName

String

The name of the application

tierMapName

String

The name of the tier map.

applicationEntityRevisionId

String

Revisionid of the versioned object

applicationTierName

String

Name of the application tier.

environmentName

String

The name of the environment.

environmentProjectName

String

The name of the environment’s project name.

environmentTierName

String

Name of the environment tier.

resourceExpression

String

resource expression to pick up resources from the environment tier

tierMappingName

String

The name of the tierMapping.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deleteTierMapping

Deletes a tier mapping from a tier map.

Arguments

Argument NameTypeDescription

projectName

String

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

applicationName

String

The name of the application (Required)

applicationTierName

String

The name of the application tier. (Required)

environmentName

String

The name of the environment. (Required)

environmentProjectName

String

The name of the environment’s project name. (Required)

applicationEntityRevisionId

String

Revisionid of the versioned object

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteTierMapping(
                projectName: 'test-projectName',
                applicationName: 'test-applicationName',
                applicationTierName: 'test-applicationTierName',
                environmentName: 'test-environmentName',
                environmentProjectName: 'test-environmentProjectName'
                /* optional arguments */)

modifyTierMapping

Modifies an existing tier mapping.

Arguments

Argument NameTypeDescription

projectName

String

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

applicationName

String

The name of the application

tierMapName

String

The name of the tier map.

applicationTierName

String

Name of the application tier.

applicationEntityRevisionId

String

Revisionid of the versioned object

environmentName

String

The name of the environment.

environmentProjectName

String

The name of the environment’s project name.

environmentTierName

String

Name of the environment tier.

newName

String

New name for an existing object that is being renamed.

resourceExpression

String

resource expression to pick up resources from the environment tier

tierMappingName

String

The name of the tierMapping.

Usage

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


ElectricFlow ef = new ElectricFlow()

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