createComponent

Back to index

Summary

Creates a new component for a project.

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.

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.

pluginKey

Stringoptional

The key of the plugin.

pluginName

Stringoptional

The name of the plugin.

pluginParameters

Array<PluginParameter>optional

List of plugin parameters.

reference

Booleanoptional

If 1 or true, a reference of the component is created. If 0 or false, a copy of the component is created.

sourceApplicationName

Stringoptional

The name of the source application.

sourceComponentName

Stringoptional

The name of new component.

sourceProjectName

Stringoptional

The name of source project.

Usage

Groovy

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

ElectricFlow ef = new ElectricFlow()

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