modifyEnvironment

Back to index

Summary

Modifies an environment.

projectName

Stringrequired

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

environmentName

Stringrequired

The name of the environment.

description

Stringoptional

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

environmentEnabled

Booleanoptional

True to enable the environment.

newName

Stringoptional

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

reservationRequired

Booleanoptional

True to allow run using reservation only.

rollingDeployEnabled

Booleanoptional

True to enable support for rolling deploy on this environment.

rollingDeployType

Stringoptional

The type of rolling deploy type supported by the environment.

Possible values: "batch", "phase"

Usage

Groovy

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

ElectricFlow ef = new ElectricFlow()

def result = ef.modifyEnvironment(
  projectName: "test-projectName",
  environmentName: "test-environmentName"
  /* optional arguments */
)▼