Procedure

createProcedure

Creates a new procedure for an existing project.

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)
credentialName	String	The name of a credential to attach to this procedure.
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
jobNameTemplate	String	Template used to determine the default name of jobs launched from a procedure.
resourceName	String	The name of the default resource for this procedure.
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.
workspaceName	String	The name of the default workspace for this procedure.

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)

credentialName

String

The name of a credential to attach to this procedure.

description

String

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

jobNameTemplate

String

Template used to determine the default name of jobs launched from a procedure.

resourceName

String

The name of the default resource for this procedure.

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.

workspaceName

String

The name of the default workspace for this procedure.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deleteProcedure

Deletes a procedure, including all steps.

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)

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.deleteProcedure(
                projectName: 'test-projectName',
                procedureName: 'test-procedureName')

getProcedure

Finds a procedure by its name.

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)

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.getProcedure(
                projectName: 'test-projectName',
                procedureName: 'test-procedureName')

getProcedures

Retrieves all procedures in a project.

Arguments

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

Argument Name

Type

Description

projectName

String

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

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getProcedures(
                projectName: 'test-projectName')

modifyProcedure

Modifies an existing 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)
credentialName	String	The name of a credential to attach to this procedure.
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
jobNameTemplate	String	Template used to determine the default name of jobs launched from a procedure.
newName	String	The new name for an existing object that is being renamed.
resourceName	String	The name of the default resource for this procedure.
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.
workspaceName	String	The name of the default workspace for this procedure.

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)

credentialName

String

The name of a credential to attach to this procedure.

description

String

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

jobNameTemplate

String

Template used to determine the default name of jobs launched from a procedure.

newName

String

The new name for an existing object that is being renamed.

resourceName

String

The name of the default resource for this procedure.

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.

workspaceName

String

The name of the default workspace for this procedure.

Usage

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


ElectricFlow ef = new ElectricFlow()

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