Actions YAML Reference
Properties | List of all members
SetVariableAction Class Reference

Sets the value of one variable. More...

Inherits IntegrationAction.

Properties

string VariableName [get, set]
 Specifies the name of the variable. More...
 
SerializableString VariableValue [get, set]
 Specifies the value of the variable. More...
 
CommonActionProperties

Describes the common action properties for Actions and ActionGroups.

string Name [get, set]
 Specifies the name. This property cannot be empty and must be unique in the YAML script. More...
 
string Description [get, set]
 Specifies the description. The default value is "". More...
 
ActionRunType RunType [get, set]
 Runs the action by using one of the following types: More...
 
bool IgnoreErrors [get, set]
 Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false. More...
 
int FailureRetries [get, set]
 Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0. More...
 
int RetryInterval [get, set]
 Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000. More...
 

Detailed Description

Sets the value of one variable.

For common action properties, see IntegrationAction.
Example:

Actions:
- SetVariableAction:
VariableName: Variable1
VariableValue: My computer name is %ComputerName%.
Name: Set Variable
# And more common action properties
...
string VariableName
Specifies the name of the variable.
Definition: SetVariableAction.Properties.cs:56
SerializableString VariableValue
Specifies the value of the variable.
Definition: SetVariableAction.Properties.cs:66
string Name
Specifies the name. This property cannot be empty and must be unique in the YAML script.
Definition: IntegrationAction.Properties.cs:87

Property Documentation

◆ VariableName

string VariableName
getset

Specifies the name of the variable.

◆ VariableValue

SerializableString VariableValue
getset

Specifies the value of the variable.

◆ Name

string Name
getsetinherited

Specifies the name. This property cannot be empty and must be unique in the YAML script.

◆ Description

string Description
getsetinherited

Specifies the description. The default value is "".

◆ RunType

ActionRunType RunType
getsetinherited

Runs the action by using one of the following types:

  • Always (default)
  • Never

◆ IgnoreErrors

bool IgnoreErrors
getsetinherited

Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false.

◆ FailureRetries

int FailureRetries
getsetinherited

Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0.

◆ RetryInterval

int RetryInterval
getsetinherited

Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000.


The documentation for this class was generated from the following file: