retryTask

Summary

Retries a pipeline task. This only applies to tasks that are waiting for a manual retry. It can be any pipeline task (excluding MANUAL, 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.

For a list of object types in CloudBees CD/RO, refer to Object types in CloudBees CD/RO.

flowRuntimeId

Stringrequired

The ID of the flow runtime.

stageName

Stringrequired

The name of the stage.

taskName

Stringrequired

The name of the task.

action

Stringoptional

Action to execute: rerun (default), skip or fail the task.

Possible values: "archiveOnly", "purgeAfterArchive", "purgeOnly"

comment

Stringoptional

Comment provided while retry an action on the manual process step or manual task or gate task.

gateType

Stringoptional

The type of the gate.

Possible values: "POST", "PRE"

subapplication

Stringoptional

The name of the sub application.

subproject

Stringoptional

The 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(
  flowRuntimeId: "test-flowRuntimeId",
  stageName: "test-stageName",
  taskName: "test-taskName"
  /* optional arguments */
)▼