Interface WorkflowService
-
- All Implemented Interfaces:
public interface WorkflowService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceWorkflowService.WithRawResponseA view of WorkflowService that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract WorkflowService.WithRawResponsewithRawResponse()Returns a view of this service that provides access to raw HTTP responses for each method. Stringcancel(String key, WorkflowCancelParams params)When invoked for a workflow using a specific workflow key and cancellation key, will cancel any queued workflow runs associated with that key/cancellation key pair. Stringcancel(String key, WorkflowCancelParams params, RequestOptions requestOptions)Stringcancel(WorkflowCancelParams params)abstract Stringcancel(WorkflowCancelParams params, RequestOptions requestOptions)WorkflowTriggerResponsetrigger(String key, WorkflowTriggerParams params)Trigger a workflow (specified by the key) to run for the given recipients, using the parameters provided. WorkflowTriggerResponsetrigger(String key, WorkflowTriggerParams params, RequestOptions requestOptions)WorkflowTriggerResponsetrigger(WorkflowTriggerParams params)abstract WorkflowTriggerResponsetrigger(WorkflowTriggerParams params, RequestOptions requestOptions)-
-
Method Detail
-
withRawResponse
abstract WorkflowService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
cancel
String cancel(String key, WorkflowCancelParams params)
When invoked for a workflow using a specific workflow key and cancellation key, will cancel any queued workflow runs associated with that key/cancellation key pair. Can optionally be provided one or more recipients to scope the request to.
-
cancel
String cancel(String key, WorkflowCancelParams params, RequestOptions requestOptions)
-
cancel
String cancel(WorkflowCancelParams params)
-
cancel
abstract String cancel(WorkflowCancelParams params, RequestOptions requestOptions)
-
trigger
WorkflowTriggerResponse trigger(String key, WorkflowTriggerParams params)
Trigger a workflow (specified by the key) to run for the given recipients, using the parameters provided. Returns an identifier for the workflow run request. All workflow runs are executed asynchronously. This endpoint also handles /managing-recipients/identifying-recipients#inline-identifying-recipients for the
actor,recipient, andtenantfields.
-
trigger
WorkflowTriggerResponse trigger(String key, WorkflowTriggerParams params, RequestOptions requestOptions)
-
trigger
WorkflowTriggerResponse trigger(WorkflowTriggerParams params)
-
trigger
abstract WorkflowTriggerResponse trigger(WorkflowTriggerParams params, RequestOptions requestOptions)
-
-
-
-