Version:
OtterVariable Class
Represents an Otter variable value.
Inheritance Hierarchy
- object
- Inedo.Otter.Variables.OtterVariable
Syntax
public
class
OtterVariable : Inedo.ExecutionEngine.Executer.IRuntimeVariable
Properties
|
Name |
Description |
|
|
EnvironmentId
|
Gets the environment ID of the variable scope if applicable.
|
|
|
EvaluateVariables
|
Gets a value indicating whether to evaluate variables processed within this variable's value.
|
|
|
HasMultipleScopes
|
Gets a value indicating whether the variable has more than one scope.
|
|
|
HostId
|
Gets the host ID of the variable scope if applicable.
|
|
|
Id
|
Gets the ID of the variable.
|
|
|
JobId
|
Gets the job ID of the variable scope if applicable.
|
|
|
Name
|
Gets the name and type of the variable.
|
|
|
Scope
|
Gets the scope of the variable.
|
|
|
Sensitive
|
Gets a value indicating whether to obscure the value of this variable from casual viewing.
|
|
|
ServerId
|
Gets the server ID of the variable scope if applicable.
|
|
|
ServerRoleId
|
Gets the role ID of the variable scope if applicable.
|
|
|
UnprocessedValue
|
Gets the value as it was persisted in storage.
|
|
|
Value
|
Gets the variable value.
|
Methods
|
Name |
Description |
|
|
GetCascadedVariable(string variableName, int? serverId, int? environmentId, int? serverRoleId, int? jobId, int? hostId, bool? expandRolesAndEnvironments, bool? includeSystemVariables)
|
Returns the specified variable or any other matching variable in a containing scope.
|
|
|
GetVariablesAccessibleFromScope(int? serverId, int? environmentId, int? serverRoleId, int? jobId, int? hostId, string variableName, bool? expandRolesAndEnvironments, bool? includeSystemVariables)
|
Returns a sequence of all of the variables that are defined in the specified scope, or
defined in a scope that logically contains the specified scope.
|
|
|
GetVariablesForScope(int? serverId, int? environmentId, int? serverRoleId, int? jobId, int? hostId)
|
Returns a sequence of all of the variables that are defined in the specified scope.
|
|
|
ToString
|
Returns a string representation of the variable and its value.
|
