Project commands

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

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 and procedure steps.

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.

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

Find a project by name.

Arguments

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

Retrieve 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 a 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 Flow.

newName

String

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 */)