modifyComponent

Back to index

Summary

Modifies an existing component.

projectName

Stringrequired

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

componentName

Stringrequired

The name of the component.

actualParameters

Array<ActualParameter>optional

Parameters passed as arguments to the application component.

applicationName

Stringoptional

The name of an application to scope this component to.

clearActualParameters

Booleanoptional

If true, the step should remove all actual parameters.

credentialName

Stringoptional

The name of a credential to attach to this component.

description

Stringoptional

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

newName

Stringoptional

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

pluginKey

Stringoptional

The key of the plugin.

pluginName

Stringoptional

The name of the plugin.

pluginParameters

Array<PluginParameter>optional

List of plugin parameters.

Usage

Groovy

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

ElectricFlow ef = new ElectricFlow()

def result = ef.modifyComponent(
  projectName: "test-projectName",
  componentName: "test-componentName"
  /* optional arguments */
)▼