Table of Contents

Class StepResult

Namespace
FlowOrchestrator.Core.Execution
Assembly
FlowOrchestrator.Core.dll

General-purpose IStepResult implementation for step handlers that return untyped output or no output at all.

public sealed class StepResult : IStepResult
Inheritance
StepResult
Implements
Inherited Members

Properties

DelayNextStep

When non-null, the orchestrator schedules the next step invocation after this delay instead of enqueueing it immediately (used by PollableStepHandler<TInput>).

public TimeSpan? DelayNextStep { get; set; }

Property Value

TimeSpan?

DispatchHint

Optional hint instructing the engine to spawn dynamic child steps after this step completes. null (the default) means the engine continues using the static DAG only. Used by ForEachStepHandler to fan out loop iterations without calling the dispatcher directly.

public StepDispatchHint? DispatchHint { get; set; }

Property Value

StepDispatchHint

FailedReason

Human-readable error message recorded when Status is Failed.

public string? FailedReason { get; set; }

Property Value

string

Key

The key of the step that produced this result. Set automatically if not populated by the handler.

public string Key { get; set; }

Property Value

string

ReThrow

When true, the orchestrator rethrows the step's exception after recording it, allowing Hangfire's built-in retry policy to kick in.

public bool ReThrow { get; set; }

Property Value

bool

Result

Optional output value serialised to JSON and stored in IOutputsRepository. Available to subsequent steps via @outputs('stepKey') expressions.

public object? Result { get; set; }

Property Value

object

Status

Terminal or intermediate status of the step. A Pending status with DelayNextStep instructs Hangfire to reschedule (polling pattern).

public StepStatus Status { get; set; }

Property Value

StepStatus