Interface FunctionsClient
-
public interface FunctionsClient
A client object providing access to the iKnowBase Functions Engine.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description FunctionRequest
request()
Creates a FunctionsRequest.String
submit(FunctionRequest request)
Submits a request for execution by the Functions engine.String
submit(String request)
Submits a request for execution by the Functions engine.FunctionResponse
submitAndWaitForResponse(FunctionRequest request, Duration maxWait)
Submits a request for execution by the Functions engine and waits for a response.FunctionResponse
submitAndWaitForResponse(String request, Duration maxWait)
Submits a request for execution by the Functions engine and waits for a response.
-
-
-
Method Detail
-
submit
String submit(FunctionRequest request)
Submits a request for execution by the Functions engine. The request can be acquired from therequest()
method.- Parameters:
request
- execution request
-
submit
String submit(String request)
Submits a request for execution by the Functions engine. The request must be in JSON format.- Parameters:
request
- json-formatted execution request
-
submitAndWaitForResponse
FunctionResponse submitAndWaitForResponse(String request, Duration maxWait)
Submits a request for execution by the Functions engine and waits for a response. The request must be in JSON format.- Parameters:
request
- json-formatted execution requestmaxWait
- duration to wait for response, can be null- Returns:
- FunctionResponse if a response was provided before maxWaitSeconds.
-
submitAndWaitForResponse
FunctionResponse submitAndWaitForResponse(FunctionRequest request, Duration maxWait)
Submits a request for execution by the Functions engine and waits for a response. The request can be acquired from therequest()
method.- Parameters:
request
- execution requestmaxWait
- duration to wait for response, can be null- Returns:
- FunctionResponse if a response was provided before maxWaitSeconds.
-
request
FunctionRequest request()
Creates a FunctionsRequest.
-
-