Support

Description

This method is used to list the generatorType for a given Generator within a given Attribute. 

The generatorName parameter is the position of the Generator (e.g. gen0, gen1, gen2).

Exceptions

The following GenRocket exceptions may be thrown by this method:  

• If the requested attributeName is not found.
• If the requested generatorName is not found.

Runtime Method Signature

Use this method signature when directly accessing the GenRocket binary runtime.

public String generatorType(String attributeName, String generatorName)

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": "generatorType",
  "parameters": {
    "attributeName": "",
    "generatorName": ""
  }
}

REST/Socket Payload Successful Payload Response

The API JSON response payload returns the value of the given domain parameterValue.

{
  "responseType": "OK",
  "data": {
     "generatorType": ""
  }
}

Example Usage

String getGeneratorType(String scenarioNameAndPath)
  EngineManual api = new EngineManual()
  api.scenarioLoad(scenarioNameAndPath, 'UserScenario')
    
  List<String> names = api.generators('User.id')
  String generatorType = api.generatorType('User.id', names[0])
}