Project

createProject

Creates a new project.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects. (Required)
credentialName	String	The name of the credential object.
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
resourceName	String	Name for the resource; must be unique among all resources.
tracked	Boolean	True to enable change tracking for this project.
workspaceName	String	The name of the workspace.

Argument Name

Type

Description

projectName

String

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

credentialName

String

The name of the credential object.

description

String

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

resourceName

String

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

tracked

Boolean

True to enable change tracking for this project.

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.createProject(
                projectName: 'test-projectName'
                /* optional arguments */)▼

deleteProject

Deletes a project, including all procedures, procedure steps, and jobs within that project.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects. (Required)
foreground	Boolean	True to delete the object in the foreground. The default is to delete the object in the background.

Argument Name

Type

Description

projectName

String

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

foreground

Boolean

True to delete the object in the foreground. The default is to delete the object in the background.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getProject

Finds a project by its name.

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.getProject(
                projectName: 'test-projectName')▼

getProjects

Retrieves all projects.

Arguments

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getProjects()▼

modifyProject

Modifies an existing project.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects. (Required)
credentialName	String	The name of the credential object.
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
newName	String	The new name for an existing object that is being renamed.
resourceName	String	Name for the resource; must be unique among all resources.
tracked	Boolean	True to enable change tracking for this project.
workspaceName	String	The name of the workspace.

Argument Name

Type

Description

projectName

String

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

credentialName

String

The name of the credential object.

description

String

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

newName

String

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

resourceName

String

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

tracked

Boolean

True to enable change tracking for this project.

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.modifyProject(
                projectName: 'test-projectName'
                /* optional arguments */)▼