modifyEnvironmentTier

Back to index

Summary

Modifies an environment tier.

projectName

Stringrequired

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

environmentName

Stringrequired

The name of the environment.

environmentTierName

Stringrequired

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

batchSize

Stringoptional

The size of the batch supported by the environment tier.

batchSizeType

Stringoptional

The type of batch size supported by the environment tier.

Possible values: "count", "percentage"

description

Stringoptional

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

newName

Stringoptional

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

resourceNames

Array<Unknown>optional

List of resources to add to the environment tier.

resourcePhaseMappings

Array<ResourcePhaseMapping>optional

A map of resource and rolling deploy phase.

resourcePoolNames

Array<Unknown>optional

List of resource pools to add to the environment tier.

resourcePoolPhaseMappings

Array<ResourcePoolPhaseMapping>optional

A map of resource pool and rolling deploy phase.

Usage

Groovy

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 */
)▼