Cancel Workflows

Subscribe here to follow Infinitic's development. Please ⭐️ us on Github!

The cancellation of a workflow stops its execution and delete its state.

We can cancel running workflows by using a stub that target them by id:

HelloWorld helloworld = client.getWorkflowById(HelloWorld.class, id);

val helloworld: HelloWorld = client.getWorkflowById(, id)


or by tag:

HelloWorld helloworld = client.getWorkflowByTag(HelloWorld.class, "foo");

val helloworld: HelloWorld = client.getWorkflowByTag(, "foo")


Cancelling a workflow cancels its child workflows as well.

If you do not want this behavior, you should dispatch your child workflow from a task.

The direct cancellation of a child workflow will trigger a CanceledWorkflowException in the parent workflow if waiting for its completion.

The cancel method waits for the adhoc message to be sent to Pulsar. If we prefer to not wait for this message to be sent, we can use the cancelAsync method.

Edit this page on GitHub Updated at Sat, Sep 10, 2022