EnvironmentDomain
EnvironmentDomain
The EnvironmentDomain
object represents an Environment Domain as you can see in the Environments panel. An EnvironmentDomain
contains Environment objects, as well as EnvironmentVariable objects; each variable takes different values depending on the selected environment.
id
id
The unique identifier (UUID) (Read-only).
name
name
The Environment Domain name as it is shown in the Environment panel (Writable property only for Importers).
order
order
The order of the Environment Domain in the Environment panel (Writable property only for Importers).
environments
environments
The array of the environments contained in this Environment Domain, ordered according to their order
property (Read-only).
variables
variables
The array of the variables contained in this Environment Domain, ordered according to their order
property (Read-only).
getEnvironmentByName
getEnvironmentByName
Argument: environmentName: string: None
The name of the Environment
.
Returns: None: Environment
Returns the Environment
in this domain matching the given name or null
.
getVariableByName
getVariableByName
Argument: variableName: string: None
The name of the EnvironmentVariable
.
Returns: None: Environment
Returns the EnvironmentVariable
in this domain matching the given name or null
.
createEnvironment
createEnvironment
Argument: environmentName: string: None
The name of the new Environment
.
Returns: None: Environment
Returns a newly created Environment
in this domain.
createEnvironmentVariable
createEnvironmentVariable
Argument: environmentVariableName: string: None
The name of the new EnvironmentVariable
.
Returns: None: EnvironmentVariable
Returns a newly created EnvironmentVariable
in this domain.