Groovy API reference

CiConfiguration

Reference

createCIConfiguration

Create a new CI Configuration.

Arguments

Argument NameTypeDescription

ciConfigurationName

String

The name of the CI Configuration. (Required)

ciConfigurationType

String

Type of CI configuration.

credentialName

String

The name of the credential.

credentialProjectName

String

The name of the project containing specified credential.

description

String

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

isDefault

Boolean

Set as default CI Configuration.

overrideDefault

Boolean

If true allows to override isDefault flag for existing default ciConfiguration

password

String

Password for authenticating with the CI server.

publicKey

String

Public key for the CI controller. Use this argument to specify the public key for the CI controller if the server is unable to retrieve the controller’s public key due to network topology.

refCIConfiguration

String

Reference CI Configuration to use the userName and password or API token.

serverUrl

String

Url to connect to CI server.

testConnection

Boolean

Whether the connection to the CI Server should be tested before saving the configuration. Defaults to false.

userName

String

Username for authenticating with the CI server.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createCIConfiguration(
                ciConfigurationName: 'test-ciConfigurationName'
                /* optional arguments */)

deleteCIConfiguration

Deletes a CI Configuration

Arguments

Argument NameTypeDescription

ciConfigurationName

String

The name of the CI Configuration. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteCIConfiguration(
                ciConfigurationName: 'test-ciConfigurationName')

getCIConfiguration

Create a new CI Configuration.

Arguments

Argument NameTypeDescription

ciConfigurationName

String

The name of the CI Configuration. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getCIConfiguration(
                ciConfigurationName: 'test-ciConfigurationName')

getCIConfigurations

Retrieve all CI Configurations

Arguments

Argument NameTypeDescription

ciConfigurationType

String

Type of CI configuration.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getCIConfigurations(
                /* optional arguments */)

modifyCIConfiguration

Modify an existing CI Configuration.

Arguments

Argument NameTypeDescription

ciConfigurationName

String

The name of the CI Configuration. (Required)

ciConfigurationType

String

Type of CI configuration.

credentialName

String

The name of the credential.

credentialProjectName

String

The name of the project containing specified credential.

description

String

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

isDefault

Boolean

Set as default CI Configuration.

newName

String

New name for an existing object that is being renamed.

overrideDefault

Boolean

If true allows to override isDefault flag for existing default ciConfiguration

password

String

Password for authenticating with the CI server.

publicKey

String

Public key for the CI controller. Use this argument to specify the public key for the CI controller if the server is unable to retrieve the controller’s public key due to network topology.

serverUrl

String

Url to connect to CI server.

testConnection

Boolean

Whether the connection to the CI Server should be tested before saving the configuration. Defaults to false.

userName

String

Username for authenticating with the CI server.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyCIConfiguration(
                ciConfigurationName: 'test-ciConfigurationName'
                /* optional arguments */)