ProcedureStep commands

createStep

Creates a new procedure step.

Arguments

Argument Name Type Description

projectName

String

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

procedureName

String

Name for the procedure; must be unique within the project. (Required)

stepName

String

Name of the step; must be unique within the procedure. (Required)

actualParameters

array

Actual parameters passed to an invoked subprocedure

afterProcedureStep

String

If specified, the procedure step will be placed after the named procedure step.

alwaysRun

Boolean

True means this step will run even if preceding steps fail in a way that aborts the job

beforeProcedureStep

String

If specified, the procedure step will be placed before the named procedure step.

broadcast

Boolean

True means replicate this step to execute (in parallel) on each of the specified resources (that is, for a pool, run the step on each of the resources in the pool).

command

String

Script to execute the functions of this step; passed to the step’s shell for execution.

comment

String

Script to execute the functions of this step; passed to the step’s shell for execution.

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.

credentialName

String

The name of the credential object.

description

String

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

errorHandling

String

Specifies error handling for this step.

exclusive

Boolean

True means the resource acquired for this step will be retained for the exclusive use of this job. This means 2 things: first, no other job will be able to use that resource, regardless of its step limit, until this job completes; second, future steps for this job will use the resource in preference to other resources, if this resource meets the needs of the steps and its step limit is not exceeded.

exclusiveMode

String

Determines the mode to use when the step acquires a resource. If set to 'none', then the default behavior for the step applies. If set to 'job', then the resource will be retained for the exclusive use of this job. If set to 'step', then the resource will be retained for the exclusive use of this step and procedure it may call. If set to 'call', then the resource will be retained for the exclusive use of all steps within the current procedure call.

logFileName

String

Name of the log file for a step; specified relative to the root directory in the job’s workspace.

parallel

Boolean

True means this step and all adjacent steps with the flag set will run in parallel.

postProcessor

String

This command runs in parallel with the main command for the step; it analyzes the log for the step and collects diagnostic information.

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.

releaseExclusive

Boolean

True means the resource acquired for this step will be no longer be retained for the exclusive use of this job when this step completes.

releaseMode

String

Determines the mode to use when the step releases its resource. If set to 'none', the default behavior applies. If set to 'release', then the resource will be available for use by any job. If set to 'releaseToJob', then the resource will be available for use by any step in this job.

resourceName

String

Name for the resource; must be unique among all resources.

shell

String

Name of the shell program that will execute the command and postprocessor for the step.

subprocedure

String

Name of a procedure to invoke during this step.

subproject

String

Name of the project containing the procedure to invoke during this step.

timeLimit

String

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

timeLimitUnits

String

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

workingDirectory

String

Working 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.

workspaceName

String

The name of the workspace.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deleteStep

Deletes a step from a procedure.

Arguments

Argument Name Type Description

projectName

String

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

procedureName

String

Name for the procedure; must be unique within the project. (Required)

stepName

String

Name of the step; must be unique within the procedure. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteStep(
                projectName: 'test-projectName',
                procedureName: 'test-procedureName',
                stepName: 'test-stepName')

getStep

Retrieve a step from a procedure.

Arguments

Argument Name Type Description

projectName

String

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

procedureName

String

Name for the procedure; must be unique within the project. (Required)

stepName

String

Name of the step; must be unique within the procedure. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getStep(
                projectName: 'test-projectName',
                procedureName: 'test-procedureName',
                stepName: 'test-stepName')

getSteps

Retrieve all steps in a procedure.

Arguments

Argument Name Type Description

projectName

String

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

procedureName

String

Name for the procedure; must be unique within the project. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getSteps(
                projectName: 'test-projectName',
                procedureName: 'test-procedureName')

modifyStep

Modifies an existing step.

Arguments

Argument Name Type Description

projectName

String

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

procedureName

String

Name for the procedure; must be unique within the project. (Required)

stepName

String

Name of the step; must be unique within the procedure. (Required)

actualParameters

array

Actual parameters passed to an invoked subprocedure

afterProcedureStep

String

If specified, the procedure step will be placed after the named procedure step.

alwaysRun

Boolean

True means this step will run even if preceding steps fail in a way that aborts the job

beforeProcedureStep

String

If specified, the procedure step will be placed before the named procedure step.

broadcast

Boolean

True means replicate this step to execute (in parallel) on each of the specified resources (that is, for a pool, run the step on each of the resources in the pool).

clearActualParameters

Boolean

True if the step should remove all actual parameters.

command

String

Script to execute the functions of this step; passed to the step’s shell for execution.

comment

String

Script to execute the functions of this step; passed to the step’s shell for execution.

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.

credentialName

String

The name of the credential object.

description

String

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

errorHandling

String

Specifies error handling for this step.

exclusive

Boolean

True means the resource acquired for this step will be retained for the exclusive use of this job. This means 2 things: first, no other job will be able to use that resource, regardless of its step limit, until this job completes; second, future steps for this job will use the resource in preference to other resources, if this resource meets the needs of the steps and its step limit is not exceeded.

exclusiveMode

String

Determines the mode to use when the step acquires a resource. If set to 'none', then the default behavior for the step applies. If set to 'job', then the resource will be retained for the exclusive use of this job. If set to 'step', then the resource will be retained for the exclusive use of this step and procedure it may call. If set to 'call', then the resource will be retained for the exclusive use of all steps within the current procedure call.

logFileName

String

Name of the log file for a step; specified relative to the root directory in the job’s workspace.

newName

String

New name for an existing object that is being renamed.

parallel

Boolean

True means this step and all adjacent steps with the flag set will run in parallel.

postProcessor

String

This command runs in parallel with the main command for the step; it analyzes the log for the step and collects diagnostic information.

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.

releaseExclusive

Boolean

True means the resource acquired for this step will be no longer be retained for the exclusive use of this job when this step completes.

releaseMode

String

Determines the mode to use when the step releases its resource. If set to 'none', the default behavior applies. If set to 'release', then the resource will be available for use by any job. If set to 'releaseToJob', then the resource will be available for use by any step in this job.

resourceName

String

Name for the resource; must be unique among all resources.

shell

String

Name of the shell program that will execute the command and postprocessor for the step.

subprocedure

String

Name of a procedure to invoke during this step.

subproject

String

Name of the project containing the procedure to invoke during this step.

timeLimit

String

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

timeLimitUnits

String

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

workingDirectory

String

Working 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.

workspaceName

String

The name of the workspace.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

moveStep

Move a step within a procedure.

Arguments

Argument Name Type Description

projectName

String

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

procedureName

String

Name for the procedure; must be unique within the project. (Required)

stepName

String

Name of the step; must be unique within the procedure. (Required)

beforeStep

String

The name of the step before which 'stepName' should appear. Blank to move the step to the last position.

Usage

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


ElectricFlow ef = new ElectricFlow()

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