Interface WorkflowServiceAsync
-
- All Implemented Interfaces:
public interface WorkflowServiceAsync
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceWorkflowServiceAsync.WithRawResponseA view of WorkflowServiceAsync that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract WorkflowServiceAsync.WithRawResponsewithRawResponse()Returns a view of this service that provides access to raw HTTP responses for each method. CompletableFuture<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. CompletableFuture<String>cancel(String key, WorkflowCancelParams params, RequestOptions requestOptions)CompletableFuture<String>cancel(WorkflowCancelParams params)abstract CompletableFuture<String>cancel(WorkflowCancelParams params, RequestOptions requestOptions)CompletableFuture<WorkflowTriggerResponse>trigger(String key, WorkflowTriggerParams params)Trigger a workflow (specified by the key) to run for the given recipients, using the parameters provided. CompletableFuture<WorkflowTriggerResponse>trigger(String key, WorkflowTriggerParams params, RequestOptions requestOptions)CompletableFuture<WorkflowTriggerResponse>trigger(WorkflowTriggerParams params)abstract CompletableFuture<WorkflowTriggerResponse>trigger(WorkflowTriggerParams params, RequestOptions requestOptions)-
-
Method Detail
-
withRawResponse
abstract WorkflowServiceAsync.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
cancel
CompletableFuture<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
CompletableFuture<String> cancel(String key, WorkflowCancelParams params, RequestOptions requestOptions)
-
cancel
CompletableFuture<String> cancel(WorkflowCancelParams params)
-
cancel
abstract CompletableFuture<String> cancel(WorkflowCancelParams params, RequestOptions requestOptions)
-
trigger
CompletableFuture<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
CompletableFuture<WorkflowTriggerResponse> trigger(String key, WorkflowTriggerParams params, RequestOptions requestOptions)
-
trigger
CompletableFuture<WorkflowTriggerResponse> trigger(WorkflowTriggerParams params)
-
trigger
abstract CompletableFuture<WorkflowTriggerResponse> trigger(WorkflowTriggerParams params, RequestOptions requestOptions)
-
-
-
-