Introduction
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogCatalog item runChange historyCI buildCI build detailCI configurationCI eventCI jobClusterComponentsCredentialCredential providerCustom filterDashboardDashboard columnDatabase configurationData retention policyDeployer applicationDevOps Insight data sourceDirectory providerDynamic environmentEmail configurationEmail notifierEnvironmentEnvironment tierGatewayGroupInstalling or upgrading remote agentsJobKerberos keytabMicroserviceMicroservice mappingMiscellaneousObjectObject tagsParameterPersonaPipelinePluginPlugin configurationPlugin catalogProcedureProcessProcess dependencyProcess stepProjectPropertyReleaseReportReporting filterReport object associationReport object attributeReport object typeResourceRolling deployScheduleSCM syncServerServer settings categoryService accounts for webhooksSessionSingle sign-on for OpenID ConnectSingle sign-on for SAMLSnapshotsTier mapTriggerUserUser emailUtility resourceWait dependencyWebhook resultWidgetWidget filter overrideWorkflowWorkflow definitionWork itemsWorkspaceZone
Perl API response and element glossary
Introduction
Examples
Troubleshooting
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

EnvironmentTemplateTier

3 minute readReference

addResourceTemplateToEnvironmentTemplateTier

Adds a resource template to the specified environment template tier.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

The name of the environment template. (Required)

environmentTemplateTierName

String

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

resourceTemplateName

String

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

resourceCount

Integer

The number of resources to be spun from a given resource template.

resourceTemplateProjectName

String

Name for the project to which the resource template belongs to.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.addResourceTemplateToEnvironmentTemplateTier(
                projectName: 'test-projectName',
                environmentTemplateName: 'test-environmentTemplateName',
                environmentTemplateTierName: 'test-environmentTemplateTierName',
                resourceTemplateName: 'test-resourceTemplateName'
                /* optional arguments */)
▼

addResourceToEnvironmentTemplateTier

Adds a resource to the specified environment template tier.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

The name of the environment template. (Required)

environmentTemplateTierName

String

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

resourceName

String

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

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.addResourceToEnvironmentTemplateTier(
                projectName: 'test-projectName',
                environmentTemplateName: 'test-environmentTemplateName',
                environmentTemplateTierName: 'test-environmentTemplateTierName',
                resourceName: 'test-resourceName')
▼

createEnvironmentTemplateTier

Creates a tier in an environment template.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

The name of the environment template. (Required)

environmentTemplateTierName

String

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

description

String

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

resourceCount

Integer

The number of resources to be spun from a given resource template.

resourceNames

String array

List of resources to add to the environment tier.

resourceTemplateName

String

Name for the resource template; must be unique among all resource templates.

resourceTemplateProjectName

String

Name for the project to which the resource template belongs to.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deleteEnvironmentTemplateTier

Deletes an environment template tier.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

The name of the environment template. (Required)

environmentTemplateTierName

String

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

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteEnvironmentTemplateTier(
                projectName: 'test-projectName',
                environmentTemplateName: 'test-environmentTemplateName',
                environmentTemplateTierName: 'test-environmentTemplateTierName')
▼

getEnvironmentTemplateTier

Retrieves an environment tier in an environment template.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

The name of the environment template. (Required)

environmentTemplateTierName

String

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

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getEnvironmentTemplateTier(
                projectName: 'test-projectName',
                environmentTemplateName: 'test-environmentTemplateName',
                environmentTemplateTierName: 'test-environmentTemplateTierName')
▼

getEnvironmentTemplateTiers

Retrieves all environment template tiers in the specified environment template.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

The name of the environment template. (Required)

includeTemplateDetails

Boolean

True to include resource template details.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

modifyEnvironmentTemplateTier

Modifies all environment template tiers in the specified environment template.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

The name of the environment template. (Required)

environmentTemplateTierName

String

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

description

String

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

newName

String

The new name for an existing object that is being renamed.

resourceCount

Integer

The number of resources to be spun from a given resource template.

resourceNames

String array

List of resources to add to the environment tier.

resourceTemplateName

String

Name for the resource template; must be unique among all resource templates.

resourceTemplateProjectName

String

Name for the project to which the resource template belongs to.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyEnvironmentTemplateTier(
                projectName: 'test-projectName',
                environmentTemplateName: 'test-environmentTemplateName',
                environmentTemplateTierName: 'test-environmentTemplateTierName'
                /* optional arguments */)
▼
environmenttemplate
environmenttemplatetiermap