EnvironmentTemplate commands

createEnvironmentTemplate

Create a new environment template.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

The name of the environment template. (Required)

description

String

Comment text describing this object that is not interpreted at all by CloudBees Flow.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createEnvironmentTemplate(
                projectName: 'test-projectName',
                environmentTemplateName: 'test-environmentTemplateName'
                /* optional arguments */)

deleteEnvironmentTemplate

Deletes an environment template.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

The name of the environment template. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteEnvironmentTemplate(
                projectName: 'test-projectName',
                environmentTemplateName: 'test-environmentTemplateName')

getEnvironmentTemplate

Retrieve an environment template by name.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

The name of the environment template. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getEnvironmentTemplate(
                projectName: 'test-projectName',
                environmentTemplateName: 'test-environmentTemplateName')

getEnvironmentTemplates

Retrieve all environment templates in a project.

Arguments

Argument Name Type Description

projectName

String

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

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getEnvironmentTemplates(
                projectName: 'test-projectName')

modifyEnvironmentTemplate

Modify an environment template.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

The name of the environment template. (Required)

description

String

Comment text describing this object that is not interpreted at all by CloudBees Flow.

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.modifyEnvironmentTemplate(
                projectName: 'test-projectName',
                environmentTemplateName: 'test-environmentTemplateName'
                /* optional arguments */)