Back to index
Summary
Retries a pipeline task. This only applies to tasks that are waiting for a manual retry. It can be any pipeline task (excludingMANUAL
, APPROVAL
, GROUP
, and DEPLOYER
tasks) or an application deployment that is a part of a deployer task. For application deployments, a subapplication (and a subproject by Perforce) should be provided.requestStringrequiredThis parameter and the value displayed are required; request=retryTask must appear in your query string.flowRuntimeIdStringrequiredThe ID of the flow runtime. stageNameStringrequiredThe name of the stage. taskNameStringrequiredThe name of the task. actionStringoptionalAction to execute: rerun (default), skip or fail the task. Possible values: "fail" , "rerun" , "skip" commentStringoptionalComment provided while retry an action on the manual process step or manual task or gate task. gateTypeStringoptionalThe type of the gate. Possible values: "POST" , "PRE" subapplicationStringoptionalThe name of the sub application. subprojectStringoptionalThe name of the project that contains the sub application. |
Usage
Groovy
import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.retryTask( request: "test-request", flowRuntimeId: "test-flowRuntimeId", stageName: "test-stageName", taskName: "test-taskName" /* optional arguments */ )