Stage

createStage

Creates a new stage for a project.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects. (Required)
stageName	String	The name of the stage (Required)
afterStage	String	If specified, the stage will be placed after the named stage.
beforeStage	String	If specified, the stage will be placed before the named stage.
colorCode	String	The hexadecimal value of the color to be used with an entity.
completed	Boolean	Set true to complete and false to incomplete a stage with manual completion type. A stage with auto completion type ignores this argument.
completionType	String	The stage completion type: auto (be default) or manual
condition	String	A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a "0" or "false" is interpreted as FALSE. Any other result string is interpreted as TRUE.
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD.
duration	String	Duration in minutes for which the stage or task should relative to 'plannedStartDate'.
incompletePostStages	Boolean	If True then in case off specified stage inclompletion all post stages are incompleted too.
parallelToPrevious	Boolean	If TRUE, the flow state will be run in parallel to the previous flow state
pipelineName	String	The name of the pipeline
plannedEndDate	String	The date when this stage or task is expected to end.
plannedStartDate	String	The date when this stage or task is expected to start.
precondition	String	A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a "0" or "false" is interpreted as FALSE. Any other result string is interpreted as TRUE.
releaseName	String	The name of the release
resourceName	String	The name of the default resource for this stage.
timeZone	String	The time zone to use when interpreting times.
waitForPlannedStartDate	Boolean	True to enable waiting for planned start date.

Argument Name

Type

Description

projectName

String

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

stageName

String

The name of the stage (Required)

afterStage

String

If specified, the stage will be placed after the named stage.

beforeStage

String

If specified, the stage will be placed before the named stage.

colorCode

String

The hexadecimal value of the color to be used with an entity.

completed

Boolean

Set true to complete and false to incomplete a stage with manual completion type. A stage with auto completion type ignores this argument.

completionType

String

The stage completion type: auto (be default) or manual

condition

String

A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a "0" or "false" is interpreted as FALSE. Any other result string is interpreted as TRUE.

description

String

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

duration

String

Duration in minutes for which the stage or task should relative to 'plannedStartDate'.

incompletePostStages

Boolean

If True then in case off specified stage inclompletion all post stages are incompleted too.

parallelToPrevious

Boolean

If TRUE, the flow state will be run in parallel to the previous flow state

pipelineName

String

The name of the pipeline

plannedEndDate

String

The date when this stage or task is expected to end.

plannedStartDate

String

The date when this stage or task is expected to start.

precondition

String

A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a "0" or "false" is interpreted as FALSE. Any other result string is interpreted as TRUE.

releaseName

String

The name of the release

resourceName

String

The name of the default resource for this stage.

timeZone

String

The time zone to use when interpreting times.

waitForPlannedStartDate

Boolean

True to enable waiting for planned start date.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createStage(
                projectName: 'test-projectName',
                stageName: 'test-stageName'
                /* optional arguments */)

deleteStage

Delete a stage.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects. (Required)
stageName	String	The name of the stage (Required)
pipelineName	String	The name of the pipeline
releaseName	String	The name of the release

Argument Name

Type

Description

projectName

String

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

stageName

String

The name of the stage (Required)

pipelineName

String

The name of the pipeline

releaseName

String

The name of the release

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteStage(
                projectName: 'test-projectName',
                stageName: 'test-stageName'
                /* optional arguments */)

getStage

Retrieve a stage by name.

Arguments

Argument Name	Type	Description
stageName	String	The name of the stage (Required)
projectName	String	The name for the project that must be unique among all projects. (Required)
pipelineName	String	The name of the pipeline
releaseName	String	The name of the release
timeZone	String	The time zone to use when interpreting times.

Argument Name

Type

Description

stageName

String

The name of the stage (Required)

projectName

String

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

pipelineName

String

The name of the pipeline

releaseName

String

The name of the release

timeZone

String

The time zone to use when interpreting times.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getStage(
                stageName: 'test-stageName',
                projectName: 'test-projectName'
                /* optional arguments */)

getStages

Retrieve all stages.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects. (Required)
pipelineName	String	The name of the pipeline
releaseName	String	The name of the release

Argument Name

Type

Description

projectName

String

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

pipelineName

String

The name of the pipeline

releaseName

String

The name of the release

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getStages(
                projectName: 'test-projectName'
                /* optional arguments */)

getWaitDependencies

Get all pipeline dependencies of a stage or task.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects. (Required)
pipelineName	String	The name of the pipeline
stageName	String	The name of the stage
gateType	String	The type of gate.
releaseName	String	The name of the release
taskName	String	The name of the task

Argument Name

Type

Description

projectName

String

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

pipelineName

String

The name of the pipeline

stageName

String

The name of the stage

gateType

String

The type of gate.

releaseName

String

The name of the release

taskName

String

The name of the task

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getWaitDependencies(
                projectName: 'test-projectName',
                /* optional arguments */)

modifyStage

Modifies an existing stage.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects. (Required)
stageName	String	The name of the stage (Required)
afterStage	String	If specified, the stage will be placed after the named stage.
beforeStage	String	If specified, the stage will be placed before the named stage.
colorCode	String	The hexadecimal value of the color to be used with an entity.
completed	Boolean	Set true to complete and false to incomplete a stage with manual completion type. A stage with auto completion type ignores this argument.
completionType	String	The stage completion type: auto (be default) or manual
condition	String	A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a "0" or "false" is interpreted as FALSE. Any other result string is interpreted as TRUE.
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD.
duration	String	Duration in minutes for which the stage or task should relative to 'plannedStartDate'.
incompletePostStages	Boolean	If True then in case off specified stage inclompletion all post stages are incompleted too.
newName	String	New name for an existing object that is being renamed.
parallelToPrevious	Boolean	If TRUE, the flow state will be run in parallel to the previous flow state
pipelineName	String	The name of the pipeline
plannedEndDate	String	The date when this stage or task is expected to end.
plannedStartDate	String	The date when this stage or task is expected to start.
precondition	String	A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a "0" or "false" is interpreted as FALSE. Any other result string is interpreted as TRUE.
releaseName	String	The name of the release
resourceName	String	The name of the default resource for this stage.
timeZone	String	The time zone to use when interpreting times.
waitForPlannedStartDate	Boolean	True to enable waiting for planned start date.

Argument Name

Type

Description

projectName

String

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

stageName

String

The name of the stage (Required)

afterStage

String

If specified, the stage will be placed after the named stage.

beforeStage

String

If specified, the stage will be placed before the named stage.

colorCode

String

The hexadecimal value of the color to be used with an entity.

completed

Boolean

Set true to complete and false to incomplete a stage with manual completion type. A stage with auto completion type ignores this argument.

completionType

String

The stage completion type: auto (be default) or manual

condition

String

A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a "0" or "false" is interpreted as FALSE. Any other result string is interpreted as TRUE.

description

String

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

duration

String

Duration in minutes for which the stage or task should relative to 'plannedStartDate'.

incompletePostStages

Boolean

If True then in case off specified stage inclompletion all post stages are incompleted too.

newName

String

New name for an existing object that is being renamed.

parallelToPrevious

Boolean

If TRUE, the flow state will be run in parallel to the previous flow state

pipelineName

String

The name of the pipeline

plannedEndDate

String

The date when this stage or task is expected to end.

plannedStartDate

String

The date when this stage or task is expected to start.

precondition

String

A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a "0" or "false" is interpreted as FALSE. Any other result string is interpreted as TRUE.

releaseName

String

The name of the release

resourceName

String

The name of the default resource for this stage.

timeZone

String

The time zone to use when interpreting times.

waitForPlannedStartDate

Boolean

True to enable waiting for planned start date.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyStage(
                projectName: 'test-projectName',
                stageName: 'test-stageName'
                /* optional arguments */)

removeTaskGroup

Removes the task group without deleting the tasks.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects. (Required)
pipelineName	String	The name of the pipeline
stageName	String	Name of the stage to which this task belongs to.
gateType	String	The type of the gate.
groupName	String	The name of the group task
releaseName	String	The name of the release

Argument Name

Type

Description

projectName

String

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

pipelineName

String

The name of the pipeline

stageName

String

Name of the stage to which this task belongs to.

gateType

String

The type of the gate.

groupName

String

The name of the group task

releaseName

String

The name of the release

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.removeTaskGroup(
                projectName: 'test-projectName',
                /* optional arguments */)