StateMachineInfo

data class StateMachineInfo constructor(val id: StateMachineRunId, val flowLogicClassName: String, val initiator: FlowInitiator, val progressTrackerStepAndUpdates: DataFeed<String, String>?, val invocationContext: InvocationContext = initiator.invocationContext)

Represents information about a flow (the name "state machine" is legacy, Kotlin users can use the FlowInfo type alias). You can access progress tracking, information about why the flow was started and so on.

Constructors

Link copied to clipboard
constructor(id: StateMachineRunId, flowLogicClassName: String, initiator: FlowInitiator, progressTrackerStepAndUpdates: DataFeed<String, String>?, invocationContext: InvocationContext = initiator.invocationContext)

Properties

Link copied to clipboard

The JVM class name of the flow code.

Link copied to clipboard

A universally unique ID (java.util.UUID) representing this particular instance of the named flow.

Link copied to clipboard

An object representing information about the initiator of the flow. Note that this field is superseded by the invocationContext property, which has more detail.

Link copied to clipboard

An InvocationContext describing why and by whom the flow was started.

Link copied to clipboard

A DataFeed of the current progress step as a human readable string, and updates to that string.

Functions

Link copied to clipboard
fun copy(id: StateMachineRunId = this.id, flowLogicClassName: String = this.flowLogicClassName, initiator: FlowInitiator = this.initiator, progressTrackerStepAndUpdates: DataFeed<String, String>? = this.progressTrackerStepAndUpdates): StateMachineInfo
Link copied to clipboard
open override fun toString(): String