Back to index
Summary
Modifies an existing process step.projectNameStringrequiredThe name for the project that must be unique among all projects. componentNameStringoptionalThe name of the component, if the process is owned by a component. processNameStringrequiredThe name of the process. processStepNameStringrequiredThe name of the process step. actionLabelTextStringoptionalThe JSON derived action label text. actualParametersArray<ActualParameter>optionalActual parameters passed to an invoked subprocedure or process. afterLastRetryStringoptionalSpecifies error handling for the auto retry step. Possible values: "continueOnError" , "stopOnError" afterProcessStepStringoptionalIf specified, the process step will be placed after the named process step. allowSkipBooleanoptionalWhen enabled, manual process step can be skipped. alwaysRunBooleanoptionalTrue means this step will run even if preceding steps fail in a way that aborts the job. applicationNameStringoptionalThe name of the application, if the process is owned by an application. applicationTierNameStringoptionalIf references an application tier, the name of the application tier. assigneesArray<Unknown>optionalA list of assignees who receive the notification. beforeProcessStepStringoptionalIf specified, the process step will be placed before the named process step. clearActualParametersBooleanoptionalIf true , the step should remove all actual parameters.componentApplicationNameStringoptionalIf specified, the component is scoped to this application not the project. componentRollbackBooleanoptionalWhen enabled, rollback will be performed only for the components that were not deployed successfully. credentialNameStringoptionalThe name of the credential object. dependencyJoinTypeStringoptionalJoin type for incoming dependencies. Possible values: "and" , "or" descriptionStringoptionalComment text describing this object that is not interpreted at all by CloudBees CD/RO. disableFailureBooleanoptionalTrue means a manual process step cannot be failed. emailConfigNameStringoptionalThe name of email configuration. errorHandlingStringoptionalSpecifies error handling for this step. Possible values: "continueOnError" , "retryOnError" , "stopOnError" includeCompParameterRefBooleanoptionalTrue if the actual parameters should be generated from component properties. Works for artifact components only. instructionStringoptionalInstruction associated with the manual process step. microserviceApplicationNameStringoptionalIf specified, the microservice is scoped to an application. microserviceNameStringoptionalThe name of the microservice, if the process is owned by a microservice. newNameStringoptionalThe new name for an existing object that is being renamed. notificationEnabledBooleanoptionalTrue means this email notification is enabled, false otherwise. notificationTemplateStringoptionalEmail notification template for process step. processStepTypeStringoptionalDefines type of the process step. Possible values: "command" , "component" , "manual" , "none" , "plugin" , "procedure" , "process" , "rollback" , "service" , "utility" retryCountIntegeroptionalIf the retry is auto, specify the maximum number of times retry should occur. retryIntervalIntegeroptionalIf the retry is auto, specify the interval in seconds after which retry should be attempted. retryTypeStringoptionalType of retry when process step fails. Is one of auto or manual .Possible values: "auto" , "manual" rollbackSnapshotStringoptionalName of Snapshot to be used for rollback. rollbackTypeStringoptionalThe type of the rollback. Possible values: "environment" , "snapshot" rollbackUndeployProcessStringoptionalName of the undeploy process to be used during rollback. skipRollbackIfUndeployFailsBooleanoptionalWhen enabled, rollback will be performed only for the components that were successfully undeployed. smartRollbackBooleanoptionalSmart deploy flag to be used during rollback is triggered. subcomponentStringoptionalIf referencing a component process, the name of the component. subcomponentApplicationNameStringoptionalIf referencing a component process, the name of the component application (if not project scoped). subcomponentProcessStringoptionalIf referencing a component process, the name of the component process. submicroserviceStringoptionalIf referencing a microservice, the name of the microservice. submicroserviceProcessStringoptionalIf referencing a microservice process, the name of the microservice process. subprocedureStringoptionalIf referencing a procedure, the name of the procedure. subprojectStringoptionalIf referencing a procedure, the name of the procedure's project. timeLimitStringoptionalMaximum amount of time the step can execute; abort if it exceeds this time. timeLimitUnitsStringoptionalUnits for step time limit: seconds, minutes, or hours. Possible values: "hours" , "minutes" , "seconds" useUtilityResourceBooleanoptionalTrue means that step will run on utility resource instead of a tier. utilityResourceNameStringoptionalUtility resource name. workingDirectoryStringoptionalWorking directory in which to execute the command for this step. A relative name is interpreted relative to the root directory for the job's workspace. workspaceNameStringoptionalThe name of the workspace. |
Usage
Groovy
import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.modifyProcessStep( projectName: "test-projectName", processName: "test-processName", processStepName: "test-processStepName" /* optional arguments */ )