Class FlowOrchestratorBuilder

Namespace

FlowOrchestrator.Core.Configuration

Assembly

FlowOrchestrator.Core.dll

Fluent builder returned by AddFlowOrchestrator() for configuring storage backends, flows, and optional features (Hangfire, scheduler, retention, observability).

public sealed class FlowOrchestratorBuilder

Inheritance

object

FlowOrchestratorBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

InMemoryServiceCollectionExtensions.UseInMemory(FlowOrchestratorBuilder)

InMemoryServiceCollectionExtensions.UseInMemoryRuntime(FlowOrchestratorBuilder)

PostgreSqlServiceCollectionExtensions.AddPostgreSqlWebhookHardening(FlowOrchestratorBuilder, string)

PostgreSqlServiceCollectionExtensions.UsePostgreSql(FlowOrchestratorBuilder, string)

FlowOrchestratorBuilderServiceBusExtensions.UseAzureServiceBusRuntime(FlowOrchestratorBuilder, Action<ServiceBusRuntimeOptions>)

Constructors

FlowOrchestratorBuilder(IServiceCollection)

Initialises the builder with the application's service collection.

public FlowOrchestratorBuilder(IServiceCollection services)

Parameters

services IServiceCollection

Properties

HangfireEnabled

true when UseHangfire() has been called. Checked by the Hangfire integration's service registration to conditionally wire Hangfire-specific services.

public bool HangfireEnabled { get; }

Property Value

bool

Observability

Observability options for OpenTelemetry and event persistence.

public FlowObservabilityOptions Observability { get; }

Property Value

FlowObservabilityOptions

Retention

Retention options for the background data cleanup sweep.

public FlowRetentionOptions Retention { get; }

Property Value

FlowRetentionOptions

RunControl

Run-control options for timeout and idempotency enforcement.

public FlowRunControlOptions RunControl { get; }

Property Value

FlowRunControlOptions

Scheduler

Scheduler options controlling cron override persistence behaviour.

public FlowSchedulerOptions Scheduler { get; }

Property Value

FlowSchedulerOptions

Services

The service collection to register services into.

public IServiceCollection Services { get; }

Property Value

IServiceCollection

Methods

AddFlow<TFlow>()

Registers TFlow as a singleton IFlowDefinition. At startup, FlowSyncHostedService validates and syncs all registered flows.

public FlowOrchestratorBuilder AddFlow<TFlow>() where TFlow : class, IFlowDefinition, new()

Returns

FlowOrchestratorBuilder

Type Parameters

TFlow

The concrete flow definition class with a default constructor.

UseHangfire()

Activates Hangfire integration. The actual registration of Hangfire-coupled services (trigger, step runner, recurring sync) is performed by AddFlowOrchestrator in the FlowOrchestrator.Hangfire assembly when this flag is set.

public FlowOrchestratorBuilder UseHangfire()

Returns

FlowOrchestratorBuilder