Class StopFlowOptions

java.lang.Object

io.superdurable.dex.StopFlowOptions

public final class StopFlowOptions
extends Object

Configures how Client.stopFlow(String) ends a running Flow.

The default constructor requests cancellation without a reason. Use the explicit constructor to terminate or fail a Flow and to attach a human-readable reason.

client.stopFlow(
        "order-123",
        new StopFlowOptions(StopType.TERMINATE, "operator request"));

Constructor Summary

Constructors

Constructor	Description
StopFlowOptions()	Creates cancellation options without an explicit reason.
StopFlowOptions(StopType type, String reason)	Creates stop options with an explicit mode and reason.

Method Summary

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StopFlowOptions

public StopFlowOptions()

Creates cancellation options without an explicit reason.

StopFlowOptions

public StopFlowOptions(StopType type,
 String reason)

Creates stop options with an explicit mode and reason.

Parameters:

type - the requested terminal behavior

reason - the user-visible reason, or null