ClientStartableFlow is a Flow that is started via RPC.

call takes in a ClientRequestBody, containing the body of the RPC request that started the flow.

The string return type is treated by the platform as a JSON encoded string to return to the REST service, and will appear in the REST flow status when the flow completes. To assist in returning valid JSON, the JsonMarshallingService can be used.

Flows implementing this interface must have a no-arg constructor. The flow invocation will fail if this constructor does not exist.

Example usage:

• Kotlin:

  
  class MyFlow : ClientStartableFlow {
  
      
      lateinit var jsonMarshallingService: JsonMarshallingService
  
      
      override fun call(requestBody: RestRequestBody): String {
          val parameters = requestBody.getRequestBodyAs<MyFlowParameters>(jsonMarshallingService)
          ...
          return jsonMarshallingService.format(parameters)
      }
  }
  

• Java:

  
  public class MyFlow implements ClientStartableFlow {
  
      
      public JsonMarshallingService jsonMarshallingService;
  
      
      
      public String call(RestRequestBody requestBody) {
          MyFlowParameters parameters = requestBody.getRequestBodyAs(jsonMarshallingService, MyFlowParameters.class);
          ...
          return jsonMarshallingService.format(parameters);
      }
  }