Groovy API reference

Zone

Reference

createZone

Creates a new zone.

Arguments

Argument NameTypeDescription

zoneName

String

The zone name. (Required)

description

String

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

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createZone(
                zoneName: 'test-zoneName'
                /* optional arguments */)

deleteZone

Deletes a zone.

Arguments

Argument NameTypeDescription

zoneName

String

The zone name. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteZone(
                zoneName: 'test-zoneName')

getZone

Find a zone by name.

Arguments

Argument NameTypeDescription

zoneName

String

The zone name. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getZone(
                zoneName: 'test-zoneName')

getZones

Retrieve all zones.

Arguments

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getZones()

modifyZone

Modifies a zone.

Arguments

Argument NameTypeDescription

zoneName

String

The zone name. (Required)

description

String

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

newName

String

New name for an existing object that is being renamed.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyZone(
                zoneName: 'test-zoneName'
                /* optional arguments */)