modifyProcedure

Back to index

Summary

Modifies an existing procedure.

projectName

Stringrequired

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

procedureName

Stringrequired

Name for the procedure; must be unique within the project.

credentialName

Stringoptional

The name of a credential to attach to this procedure.

description

Stringoptional

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

jobNameTemplate

Stringoptional

Template used to determine the default name of jobs launched from a procedure.

newName

Stringoptional

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

resourceName

Stringoptional

The name of the default resource for this procedure.

timeLimit

Stringoptional

Maximum amount of time the step can execute; abort if it exceeds this time.

timeLimitUnits

Stringoptional

Units for step time limit: seconds, minutes, or hours.

Possible values: "hours", "minutes", "seconds"

workspaceName

Stringoptional

The name of the default workspace for this procedure.

Usage

Groovy

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

ElectricFlow ef = new ElectricFlow()

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