Package io.temporal.workflow
Interface ExternalWorkflowStub
-
public interface ExternalWorkflowStubSupports signalling and cancelling any workflows by the workflow type and their id. This is useful when an external workflow type is not known at the compile time and to call workflows in other languages.
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description voidcancel()Request cancellation of the workflow execution.voidcancel(java.lang.String reason)Request cancellation of the workflow execution with a reason.static <T> ExternalWorkflowStubfromTyped(T typed)Extracts untyped ExternalWorkflowStub from a typed workflow stub created throughWorkflow.newExternalWorkflowStub(Class, String).io.temporal.api.common.v1.WorkflowExecutiongetExecution()voidsignal(java.lang.String signalName, java.lang.Object... args)Synchronously signals a workflow by invoking its signal handler.
-
-
-
Method Detail
-
fromTyped
static <T> ExternalWorkflowStub fromTyped(T typed)
Extracts untyped ExternalWorkflowStub from a typed workflow stub created throughWorkflow.newExternalWorkflowStub(Class, String).- Type Parameters:
T- type of the workflow stub interface- Parameters:
typed- typed external workflow stub- Returns:
- untyped external workflow stub for the same workflow instance.
-
getExecution
io.temporal.api.common.v1.WorkflowExecution getExecution()
- Returns:
- workflow execution used to create this stub.
-
signal
void signal(java.lang.String signalName, java.lang.Object... args)Synchronously signals a workflow by invoking its signal handler. Usually a signal handler is a method annotated withSignalMethod.- Parameters:
signalName- name of the signal handler. Usually it is a method name.args- signal method arguments- Throws:
SignalExternalWorkflowException- if there is failure to signal the workflow.
-
cancel
void cancel()
Request cancellation of the workflow execution.
-
cancel
void cancel(@Nullable java.lang.String reason)Request cancellation of the workflow execution with a reason.- Parameters:
reason- optional reason for cancellation.
-
-