Untyped
Members list
Value members
Abstract methods
Request cancellation of a workflow execution.
Request cancellation of a workflow execution.
Cancellation cancels io.temporal.workflow.CancellationScope that wraps the main workflow method. Note that workflow can take long time to get canceled or even completely ignore the cancellation request.
Attributes
- Throws:
- WorkflowNotFoundException
if the workflow execution doesn't exist or is already completed
WorkflowServiceExceptionfor all other failures including networking and service availability issues
Synchronously queries workflow by invoking its query handler. Usually a query handler is a method annotated with zio.temporal.queryMethod.
Synchronously queries workflow by invoking its query handler. Usually a query handler is a method annotated with zio.temporal.queryMethod.
Attributes
- R
type of the query result
- args
optional query arguments
- queryType
name of the query handler. Usually it is a method name.
- Returns:
query result
- Throws:
- WorkflowNotFoundException
if the workflow execution doesn't exist
WorkflowQueryExceptionif the query failed during it's execution by the workflow worker or was rejected on any stage
WorkflowServiceExceptionfor all other failures including networking and service availability issues
Fetches workflow result
Fetches workflow result
Attributes
- V
expected workflow result type
- Returns:
either interaction error or the workflow result
Synchronously signals a workflow by invoking its signal handler. Usually a signal handler is a method annotated with zio.temporal.signalMethod.
Synchronously signals a workflow by invoking its signal handler. Usually a signal handler is a method annotated with zio.temporal.signalMethod.
Attributes
- args
signal method arguments
- signalName
name of the signal handler. Usually it is a method name.
- Throws:
- WorkflowNotFoundException
if the workflow execution doesn't exist or completed and can't be signalled
WorkflowServiceExceptionfor all other failures including networking and service availability issues
Terminates a workflow execution.
Terminates a workflow execution.
Termination is a hard stop of a workflow execution which doesn't give workflow code any chance to perform cleanup.
Attributes
- details
additional details about the termination reason
- reason
optional reason for the termination request
- Throws:
- WorkflowNotFoundException
if the workflow execution doesn't exist or is already completed
WorkflowServiceExceptionfor all other failures including networking and service availability issues