corda / net.corda.core.messaging / StateMachineInfo

StateMachineInfo

data class StateMachineInfo

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

<init>

StateMachineInfo(id: StateMachineRunId, flowLogicClassName: String, initiator: FlowInitiator, progressTrackerStepAndUpdates: DataFeed<String, String>?, 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.

Properties

flowLogicClassName

val flowLogicClassName: String

The JVM class name of the flow code.

id

val id: StateMachineRunId

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

initiator

val initiator: FlowInitiator

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

invocationContext

val invocationContext: InvocationContext

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

progressTrackerStepAndUpdates

val progressTrackerStepAndUpdates: DataFeed<String, String>?

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

Functions

copy

fun copy(id: StateMachineRunId = this.id, flowLogicClassName: String = this.flowLogicClassName, initiator: FlowInitiator = this.initiator, progressTrackerStepAndUpdates: DataFeed<String, String>? = this.progressTrackerStepAndUpdates): StateMachineInfo

toString

fun toString(): String

Extension Functions

contextLogger

fun Any.contextLogger(): Logger

When called from a companion object, returns the logger for the enclosing class.