Class WorkflowProvider

Base class shared by all TypeScript SDK provider implementations.

Hierarchy (View Summary)

ProviderBase
- WorkflowProvider

Constructors

constructor

new WorkflowProvider(options: WorkflowProviderOptions): WorkflowProvider
Parameters
- options: WorkflowProviderOptions
Returns WorkflowProvider
Overrides ProviderBase.constructor

Properties

name

name: string

`Readonly`displayName

displayName: string

`Readonly`description

description: string

`Readonly`version

version: string

`Readonly`kind

kind: "workflow" = ...

Methods

resolveName

resolveName(fallback: string): void
Parameters
- fallback: string
Returns void
Inherited from ProviderBase.resolveName

providerMetadata

providerMetadata(): ProviderMetadata
Returns ProviderMetadata
Inherited from ProviderBase.providerMetadata

configureProvider

configureProvider(name: string, config: Record<string, unknown>): Promise<void>
Parameters
- name: string
- config: Record<string, unknown>
Returns Promise<void>
Inherited from ProviderBase.configureProvider

supportsHealthCheck

supportsHealthCheck(): boolean
Returns boolean
Inherited from ProviderBase.supportsHealthCheck

healthCheck

healthCheck(): Promise<void>
Returns Promise<void>
Inherited from ProviderBase.healthCheck

startProvider

startProvider(): Promise<void>
Returns Promise<void>
Inherited from ProviderBase.startProvider

warnings

warnings(): Promise<string[]>
Returns Promise<string[]>
Inherited from ProviderBase.warnings

closeProvider

closeProvider(): Promise<void>
Returns Promise<void>
Inherited from ProviderBase.closeProvider

applyDefinition

applyDefinition(
request: ApplyWorkflowProviderDefinitionRequest,
): MaybePromise<WorkflowDefinition>
Parameters
- request: ApplyWorkflowProviderDefinitionRequest
Returns MaybePromise<WorkflowDefinition>

getDefinition

getDefinition(
request: GetWorkflowProviderDefinitionRequest,
): MaybePromise<WorkflowDefinition>
Parameters
- request: GetWorkflowProviderDefinitionRequest
Returns MaybePromise<WorkflowDefinition>

listDefinitions

listDefinitions(
    request: ListWorkflowProviderDefinitionsRequest,
): MaybePromise<
    ListWorkflowProviderDefinitionsResponse
    | readonly WorkflowDefinition[],
>
Parameters
- request: ListWorkflowProviderDefinitionsRequest
Returns MaybePromise<
ListWorkflowProviderDefinitionsResponse
| readonly WorkflowDefinition[],
>

setDefinitionPaused

setDefinitionPaused(
request: SetWorkflowProviderDefinitionPausedRequest,
): MaybePromise<WorkflowDefinition>
Parameters
- request: SetWorkflowProviderDefinitionPausedRequest
Returns MaybePromise<WorkflowDefinition>

setActivationPaused

setActivationPaused(
request: SetWorkflowProviderActivationPausedRequest,
): MaybePromise<WorkflowDefinition>
Parameters
- request: SetWorkflowProviderActivationPausedRequest
Returns MaybePromise<WorkflowDefinition>

deleteDefinition

deleteDefinition(
request: DeleteWorkflowProviderDefinitionRequest,
): MaybePromise<void>
Parameters
- request: DeleteWorkflowProviderDefinitionRequest
Returns MaybePromise<void>

startRun

startRun(request: StartWorkflowProviderRunRequest): MaybePromise<WorkflowRun>
Parameters
- request: StartWorkflowProviderRunRequest
Returns MaybePromise<WorkflowRun>

getRun

getRun(request: GetWorkflowProviderRunRequest): MaybePromise<WorkflowRun>
Parameters
- request: GetWorkflowProviderRunRequest
Returns MaybePromise<WorkflowRun>

listRuns

listRuns(
request: ListWorkflowProviderRunsRequest,
): MaybePromise<ListWorkflowProviderRunsResponse | readonly WorkflowRun[]>
Parameters
- request: ListWorkflowProviderRunsRequest
Returns MaybePromise<ListWorkflowProviderRunsResponse | readonly WorkflowRun[]>

getRunEvents

getRunEvents(
    request: GetWorkflowProviderRunEventsRequest,
): MaybePromise<
    GetWorkflowProviderRunEventsResponse
    | readonly WorkflowRunEvent[],
>
Parameters
- request: GetWorkflowProviderRunEventsRequest
Returns MaybePromise<GetWorkflowProviderRunEventsResponse | readonly WorkflowRunEvent[]>

getRunOutput

getRunOutput(
request: GetWorkflowProviderRunOutputRequest,
): MaybePromise<JsonInput | GetWorkflowProviderRunOutputResponse>
Parameters
- request: GetWorkflowProviderRunOutputRequest
Returns MaybePromise<JsonInput | GetWorkflowProviderRunOutputResponse>

cancelRun

cancelRun(request: CancelWorkflowProviderRunRequest): MaybePromise<WorkflowRun>
Parameters
- request: CancelWorkflowProviderRunRequest
Returns MaybePromise<WorkflowRun>

signalRun

signalRun(
request: SignalWorkflowProviderRunRequest,
): MaybePromise<SignalWorkflowRunResponse>
Parameters
- request: SignalWorkflowProviderRunRequest
Returns MaybePromise<SignalWorkflowRunResponse>

signalOrStartRun

signalOrStartRun(
request: SignalOrStartWorkflowProviderRunRequest,
): MaybePromise<SignalWorkflowRunResponse>
Parameters
- request: SignalOrStartWorkflowProviderRunRequest
Returns MaybePromise<SignalWorkflowRunResponse>

deliverEvent

deliverEvent(
request: DeliverWorkflowProviderEventRequest,
): MaybePromise<WorkflowEvent>
Parameters
- request: DeliverWorkflowProviderEventRequest
Returns MaybePromise<WorkflowEvent>