createEnvironmentVariable
Creates a environment variable.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
environmentVariableName | String | Name for the environment variable (Required) |
containerName | String | Name for the container |
applicationEntityRevisionId | String | Revision Id of the versioned object |
applicationName | String | The name of an application to scope service. |
description | String | Comment text describing this object that is not interpreted at all by CloudBees CD. |
environmentName | String | The name of the environment which is related to the service map detail. |
environmentProjectName | String | The name of the environment project which contains the environment. |
serviceEntityRevisionId | String | Revisionid of the versioned object |
serviceMapDetailName | String | Name for the service map detail |
serviceName | String | Name for the service |
type | String | Defines a type of the environment variable |
value | String | Environment variable value |
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.createEnvironmentVariable(
projectName: 'test-projectName',
environmentVariableName: 'test-environmentVariableName'
/* optional arguments */)
deleteEnvironmentVariable
Deletes an environment variable.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
environmentVariableName | String | Name for the environment variable (Required) |
containerName | String | Name for the container |
applicationName | String | The name of an application to scope service. |
environmentName | String | The name of the environment which is related to the service map detail. |
environmentProjectName | String | The name of the environment project which contains the environment. |
serviceMapDetailName | String | Name for the service map detail |
serviceName | String | Name for the service |
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.deleteEnvironmentVariable(
projectName: 'test-projectName',
environmentVariableName: 'test-environmentVariableName'
/* optional arguments */)
getEnvironmentVariable
Retrieve an environment variable by name.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
environmentVariableName | String | Name for the environment variable (Required) |
containerName | String | Name for the container |
applicationEntityRevisionId | String | Revision Id of the versioned object |
applicationName | String | The name of an application to scope service. |
environmentName | String | The name of the environment which is related to the service map detail. |
environmentProjectName | String | The name of the environment project which contains the environment. |
serviceEntityRevisionId | String | Revisionid of the versioned object |
serviceMapDetailName | String | Name for the service map detail |
serviceName | String | Name for the service |
getEnvironmentVariables
Retrieve environment variables.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
containerName | String | Name for the container |
applicationEntityRevisionId | String | Revision Id of the versioned object |
applicationName | String | The name of an application to scope service. |
environmentName | String | The name of the environment which is related to the service map detail. |
environmentProjectName | String | The name of the environment project which contains the environment. |
serviceEntityRevisionId | String | Revisionid of the versioned object |
serviceMapDetailName | String | Name for the service map detail |
serviceName | String | Name for the service |
modifyEnvironmentVariable
Modifies a environment variable.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
environmentVariableName | String | Name for the environment variable (Required) |
containerName | String | Name for the container |
applicationEntityRevisionId | String | Revision Id of the versioned object |
applicationName | String | The name of an application to scope service. |
description | String | Comment text describing this object that is not interpreted at all by CloudBees CD. |
environmentName | String | The name of the environment which is related to the service map detail. |
environmentProjectName | String | The name of the environment project which contains the environment. |
newName | String | New name for an existing object that is being renamed. |
serviceEntityRevisionId | String | Revisionid of the versioned object |
serviceMapDetailName | String | Name for the service map detail |
serviceName | String | Name for the service |
type | String | Defines a type of the environment variable |
value | String | Environment variable value |
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.modifyEnvironmentVariable(
projectName: 'test-projectName',
environmentVariableName: 'test-environmentVariableName'
/* optional arguments */)