EnvironmentMap

2 minute readReference

createEnvironmentMap

[DEPRECATED] This API is deprecated. Creates a new service environment map for a service.

Arguments

Argument Name Type Description

projectName

String

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

environmentName

String

The name of the environment. (Required)

serviceName

String

The name of the service

description

String

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

environmentMapName

String

The name of the tier map. If not specified the operation will assume a hyphenated service and environment name.

environmentProjectName

String

The name of the environment’s project name.

serviceEntityRevisionId

String

Deprecated: Deprecated due to microservice model changes Revisionid of the versioned object

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.createEnvironmentMap( projectName: 'test-projectName', environmentName: 'test-environmentName' /* optional arguments */)

deleteEnvironmentMap

[DEPRECATED] This API is deprecated. Deletes a service environment map from a service.

Arguments

Argument Name Type Description

projectName

String

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

environmentName

String

The name of the environment. (Required)

serviceName

String

The name of the service

environmentProjectName

String

The name of the environment’s project name.

serviceEntityRevisionId

String

Deprecated: Deprecated due to microservice model changes Revisionid of the versioned object

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.deleteEnvironmentMap( projectName: 'test-projectName', environmentName: 'test-environmentName' /* optional arguments */)

getEnvironmentMaps

Retrieve all environment maps that are used by the given service.

Arguments

Argument Name Type Description

projectName

String

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

serviceName

String

Deprecated: Deprecated due to microservice model changes The name of the service

serviceEntityRevisionId

String

Deprecated: Deprecated due to microservice model changes Revisionid of the versioned object

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.getEnvironmentMaps( projectName: 'test-projectName', /* optional arguments */)

modifyEnvironmentMap

[DEPRECATED] This API is deprecated. Modifies an existing service environment map.

Arguments

Argument Name Type Description

projectName

String

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

environmentName

String

The name of the environment. (Required)

serviceName

String

The name of the service

environmentMapName

String

The name of the tier map. If not specified the operation will assume a hyphenated service and environment name.

description

String

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

environmentProjectName

String

The name of the environment’s project name.

serviceEntityRevisionId

String

Deprecated: Deprecated due to microservice model changes Revisionid of the versioned object

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.modifyEnvironmentMap( projectName: 'test-projectName', environmentName: 'test-environmentName' /* optional arguments */)