@valon-technologies/gestalt
    Preparing search index...

    Interface WorkflowProviderOptions

    Shared provider metadata and lifecycle hooks for authored providers.

    interface WorkflowProviderOptions {
        name?: string;
        displayName?: string;
        description?: string;
        version?: string;
        configure?: ConfigureHandler;
        healthCheck?: HealthCheckHandler;
        warnings?: string[] | WarningsHandler;
        start?: StartHandler;
        close?: CloseHandler;
        applyDefinition: (
            request: ApplyWorkflowProviderDefinitionRequest,
        ) => MaybePromise<WorkflowDefinition>;
        getDefinition: (
            request: GetWorkflowProviderDefinitionRequest,
        ) => MaybePromise<WorkflowDefinition>;
        listDefinitions: (
            request: ListWorkflowProviderDefinitionsRequest,
        ) => MaybePromise<
            ListWorkflowProviderDefinitionsResponse
            | readonly WorkflowDefinition[],
        >;
        setDefinitionPaused: (
            request: SetWorkflowProviderDefinitionPausedRequest,
        ) => MaybePromise<WorkflowDefinition>;
        setActivationPaused: (
            request: SetWorkflowProviderActivationPausedRequest,
        ) => MaybePromise<WorkflowDefinition>;
        deleteDefinition: (
            request: DeleteWorkflowProviderDefinitionRequest,
        ) => MaybePromise<void>;
        startRun: (
            request: StartWorkflowProviderRunRequest,
        ) => MaybePromise<WorkflowRun>;
        getRun: (
            request: GetWorkflowProviderRunRequest,
        ) => MaybePromise<WorkflowRun>;
        listRuns: (
            request: ListWorkflowProviderRunsRequest,
        ) => MaybePromise<
            ListWorkflowProviderRunsResponse
            | readonly WorkflowRun[],
        >;
        getRunEvents: (
            request: GetWorkflowProviderRunEventsRequest,
        ) => MaybePromise<
            GetWorkflowProviderRunEventsResponse
            | readonly WorkflowRunEvent[],
        >;
        getRunOutput: (
            request: GetWorkflowProviderRunOutputRequest,
        ) => MaybePromise<JsonInput | GetWorkflowProviderRunOutputResponse>;
        cancelRun: (
            request: CancelWorkflowProviderRunRequest,
        ) => MaybePromise<WorkflowRun>;
        signalRun: (
            request: SignalWorkflowProviderRunRequest,
        ) => MaybePromise<SignalWorkflowRunResponse>;
        signalOrStartRun: (
            request: SignalOrStartWorkflowProviderRunRequest,
        ) => MaybePromise<SignalWorkflowRunResponse>;
        deliverEvent: (
            request: DeliverWorkflowProviderEventRequest,
        ) => MaybePromise<WorkflowEvent>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    name?: string
    displayName?: string
    description?: string
    version?: string
    configure?: ConfigureHandler
    healthCheck?: HealthCheckHandler
    warnings?: string[] | WarningsHandler
    start?: StartHandler
    close?: CloseHandler
    listDefinitions: (
        request: ListWorkflowProviderDefinitionsRequest,
    ) => MaybePromise<
        ListWorkflowProviderDefinitionsResponse
        | readonly WorkflowDefinition[],
    >
    deleteDefinition: (
        request: DeleteWorkflowProviderDefinitionRequest,
    ) => MaybePromise<void>
    startRun: (
        request: StartWorkflowProviderRunRequest,
    ) => MaybePromise<WorkflowRun>
    getRunEvents: (
        request: GetWorkflowProviderRunEventsRequest,
    ) => MaybePromise<
        GetWorkflowProviderRunEventsResponse
        | readonly WorkflowRunEvent[],
    >
    cancelRun: (
        request: CancelWorkflowProviderRunRequest,
    ) => MaybePromise<WorkflowRun>
    deliverEvent: (
        request: DeliverWorkflowProviderEventRequest,
    ) => MaybePromise<WorkflowEvent>