Description
This method sets one or more Generator parameter values by passing a map of parameterName/value pairs.
In This Article
- Exceptions
- Runtime Method Signature
- generatorPosition Parameter
- REST/Socket Payload Request
- REST/Socket Payload Successful Payload Response
Exceptions
The following GenRocket exceptions may be thrown by this method:
- If the runtime instance is currently running another Scenario.
- If the requested domainName is not found.
- If the requested attributeName is not found.
- If the requested parameterName is not found.
- If the generatorPosition is out of bounds.
Runtime Method Signature
Use this method signature when directly accessing the GenRocket binary runtime.
public void generatorParametersSet(String attributeName, Integer generatorPosition, Map<String, Object> parameterMap)
generatorPosition Parameter
The generatorPosition parameter starts at 0 (zero) against the Attribute Generator or Linked Generators, as shown below:
REST/Socket Payload Request
Use this API JSON request payload when making an API call to the GenRocket REST or Socket Engine.
{
"interfaceType": "Manual",
"methodName": "generatorParametersSet",
"parameters": {
"attributeName": "",
"generatorPosition": "",
"parameterMap": {
"parameterName1": "",
"parameterName2": "",
"parameterName3": ""
}
}
}
REST/Socket Payload Successful Payload Response
The API JSON response payload for this method will be empty.
{ "responseType": "OK", "data": "" }