Plugin

deletePlugin

Delete a plugin, leaving the project

Arguments

Argument Name	Type	Description
pluginName	String	The name of the plugin. (Required)

Argument Name

Type

Description

pluginName

String

The name of the plugin. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deletePlugin(
                pluginName: 'test-pluginName')▼

exportPlugin

Export a wizard based plugin.

Arguments

Argument Name	Type	Description
pluginName	String	The name of the plugin. (Required)
fileName	String	The filename to which the export is done. (Required)
download	Boolean	Export plugin file will be available to download.

Argument Name

Type

Description

pluginName

String

The name of the plugin. (Required)

fileName

String

The filename to which the export is done. (Required)

download

Boolean

Export plugin file will be available to download.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.exportPlugin(
                pluginName: 'test-pluginName',
                fileName: 'test-fileName'
                /* optional arguments */)▼

getPlugin

Retrieve an installed plugin.

Arguments

Argument Name	Type	Description
pluginName	String	The name of the plugin. (Required)

Argument Name

Type

Description

pluginName

String

The name of the plugin. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getPlugin(
                pluginName: 'test-pluginName')▼

getPlugins

Retrieve all installed plugins.

Arguments

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getPlugins()▼

installPlugin

Installs a plugin.

Arguments

Argument Name	Type	Description
url	String	A locator (local file path or network url) for the plugin to install (Required)
disableProjectTracking	Boolean	If set to true when importing or exporting a project, even if the original project had change tracking enabled, make change tracking of the newly imported or exported project be disabled from its creation. If you don’t need to track changes to the new project, this avoids the change tracking overhead that would otherwise slow down the import operation, and also saves having to subsequently disable change tracking of the reimported project.
force	Boolean	If true, install should ignore a preexisting plugin.
reducedDetailChangeHistory	Boolean	Set to 0 or false to prevent importing a large project that has change tracking enabled from automatically reducing the level of detail that it tracks for the change history of the import — this will make the import operation take longer and put more load on the database, but will allow the Change History feature to still show the full detail of entities owned by the imported project that were created by the import operation.

Argument Name

Type

Description

url

String

A locator (local file path or network url) for the plugin to install (Required)

disableProjectTracking

Boolean

If set to true when importing or exporting a project, even if the original project had change tracking enabled, make change tracking of the newly imported or exported project be disabled from its creation. If you don’t need to track changes to the new project, this avoids the change tracking overhead that would otherwise slow down the import operation, and also saves having to subsequently disable change tracking of the reimported project.

force

Boolean

If true, install should ignore a preexisting plugin.

reducedDetailChangeHistory

Boolean

Set to 0 or false to prevent importing a large project that has change tracking enabled from automatically reducing the level of detail that it tracks for the change history of the import — this will make the import operation take longer and put more load on the database, but will allow the Change History feature to still show the full detail of entities owned by the imported project that were created by the import operation.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

modifyPlugin

Modifies a plugin.

Arguments

Argument Name	Type	Description
pluginName	String	The name of the plugin
author	String	The name of the plugin author.
authorUrl	String	The Url of the plugin author.
category	String	The category of the plugin.
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
extensionVersion	Integer	An extension version number should be used when modifying or extending a CloudBees provided plugin. This allows the system to differentiate between the product plugin versions and plugin versions modified or customized by you.
label	String	Label to display in lists for the plugin.
pluginWizardBased	Boolean	Whether the plugin is based on Plugin Wizard.
repositoryUrl	String	The URL of plugin’s repository.
supportLevel	Integer	The support level for the plugin.
supportsConfigurations	Boolean	Whether the plugin supports plugin configurations. If true, then the plugin configuration procedures, CreateConfiguration and DeleteConfiguration will be automatically created.

Argument Name

Type

Description

pluginName

String

The name of the plugin

author

String

The name of the plugin author.

authorUrl

String

The Url of the plugin author.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyPlugin(
                /* optional arguments */)▼

promotePlugin

Mark a plugin as the promoted version.

Arguments

Argument Name	Type	Description
pluginName	String	The name of the plugin. (Required)
promoted	Boolean	True if the plugin should be promoted, otherwise false.

Argument Name

Type

Description

pluginName

String

The name of the plugin. (Required)

promoted

Boolean

True if the plugin should be promoted, otherwise false.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

uninstallPlugin

Uninstalls a plugin.

Arguments

Argument Name	Type	Description
pluginName	String	The name of the plugin. (Required)
timeout	Integer	The optional amount of time to wait for the uninstall to complete. If not specified, defaults to the overall request timeout.

Argument Name

Type

Description

pluginName

String

The name of the plugin. (Required)

timeout

Integer

The optional amount of time to wait for the uninstall to complete. If not specified, defaults to the overall request timeout.

Usage

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


ElectricFlow ef = new ElectricFlow()

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