Class WorkflowProvider

Base class shared by all TypeScript SDK provider implementations.

Hierarchy (View Summary)

RuntimeProvider
- WorkflowProvider

Constructors

constructor

new WorkflowProvider(options: WorkflowProviderOptions): WorkflowProvider
Parameters
- options: WorkflowProviderOptions
Returns WorkflowProvider
Overrides RuntimeProvider.constructor
- Defined in ../../src/workflow.ts:155

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 RuntimeProvider.resolveName
- Defined in ../../src/provider.ts:102

runtimeMetadata

runtimeMetadata(): ProviderMetadata
Returns ProviderMetadata
Inherited from RuntimeProvider.runtimeMetadata
- Defined in ../../src/provider.ts:108

configureProvider

configureProvider(name: string, config: Record<string, unknown>): Promise<void>
Parameters
- name: string
- config: Record<string, unknown>
Returns Promise<void>
Inherited from RuntimeProvider.configureProvider
- Defined in ../../src/provider.ts:127

supportsHealthCheck

supportsHealthCheck(): boolean
Returns boolean
Inherited from RuntimeProvider.supportsHealthCheck
- Defined in ../../src/provider.ts:131

healthCheck

healthCheck(): Promise<void>
Returns Promise<void>
Inherited from RuntimeProvider.healthCheck
- Defined in ../../src/provider.ts:135

startProvider

startProvider(): Promise<void>
Returns Promise<void>
Inherited from RuntimeProvider.startProvider
- Defined in ../../src/provider.ts:139

warnings

warnings(): Promise<string[]>
Returns Promise<string[]>
Inherited from RuntimeProvider.warnings
- Defined in ../../src/provider.ts:143

closeProvider

closeProvider(): Promise<void>
Returns Promise<void>
Inherited from RuntimeProvider.closeProvider
- Defined in ../../src/provider.ts:153

startRun

startRun(
request: StartWorkflowProviderRunRequest,
): Promise<MessageInit<BoundWorkflowRun>>
Parameters
- request: StartWorkflowProviderRunRequest
Returns Promise<MessageInit<BoundWorkflowRun>>
- Defined in ../../src/workflow.ts:176

getRun

getRun(
request: GetWorkflowProviderRunRequest,
): Promise<MessageInit<BoundWorkflowRun>>
Parameters
- request: GetWorkflowProviderRunRequest
Returns Promise<MessageInit<BoundWorkflowRun>>
- Defined in ../../src/workflow.ts:182

listRuns

listRuns(request: Message): Promise<MessageInit<BoundWorkflowRun>[]>
Parameters
- request: Message
Returns Promise<MessageInit<BoundWorkflowRun>[]>
- Defined in ../../src/workflow.ts:188

cancelRun

cancelRun(
request: CancelWorkflowProviderRunRequest,
): Promise<MessageInit<BoundWorkflowRun>>
Parameters
- request: CancelWorkflowProviderRunRequest
Returns Promise<MessageInit<BoundWorkflowRun>>
- Defined in ../../src/workflow.ts:194

upsertSchedule

upsertSchedule(
request: UpsertWorkflowProviderScheduleRequest,
): Promise<MessageInit<BoundWorkflowSchedule>>
Parameters
- request: UpsertWorkflowProviderScheduleRequest
Returns Promise<MessageInit<BoundWorkflowSchedule>>
- Defined in ../../src/workflow.ts:200

getSchedule

getSchedule(
request: GetWorkflowProviderScheduleRequest,
): Promise<MessageInit<BoundWorkflowSchedule>>
Parameters
- request: GetWorkflowProviderScheduleRequest
Returns Promise<MessageInit<BoundWorkflowSchedule>>
- Defined in ../../src/workflow.ts:206

listSchedules

listSchedules(request: Message): Promise<MessageInit<BoundWorkflowSchedule>[]>
Parameters
- request: Message
Returns Promise<MessageInit<BoundWorkflowSchedule>[]>
- Defined in ../../src/workflow.ts:212

deleteSchedule

deleteSchedule(request: DeleteWorkflowProviderScheduleRequest): Promise<void>
Parameters
- request: DeleteWorkflowProviderScheduleRequest
Returns Promise<void>
- Defined in ../../src/workflow.ts:218

pauseSchedule

pauseSchedule(
request: PauseWorkflowProviderScheduleRequest,
): Promise<MessageInit<BoundWorkflowSchedule>>
Parameters
- request: PauseWorkflowProviderScheduleRequest
Returns Promise<MessageInit<BoundWorkflowSchedule>>
- Defined in ../../src/workflow.ts:224

resumeSchedule

resumeSchedule(
request: ResumeWorkflowProviderScheduleRequest,
): Promise<MessageInit<BoundWorkflowSchedule>>
Parameters
- request: ResumeWorkflowProviderScheduleRequest
Returns Promise<MessageInit<BoundWorkflowSchedule>>
- Defined in ../../src/workflow.ts:230

upsertEventTrigger

upsertEventTrigger(
request: UpsertWorkflowProviderEventTriggerRequest,
): Promise<MessageInit<BoundWorkflowEventTrigger>>
Parameters
- request: UpsertWorkflowProviderEventTriggerRequest
Returns Promise<MessageInit<BoundWorkflowEventTrigger>>
- Defined in ../../src/workflow.ts:236

getEventTrigger

getEventTrigger(
request: GetWorkflowProviderEventTriggerRequest,
): Promise<MessageInit<BoundWorkflowEventTrigger>>
Parameters
- request: GetWorkflowProviderEventTriggerRequest
Returns Promise<MessageInit<BoundWorkflowEventTrigger>>
- Defined in ../../src/workflow.ts:242

listEventTriggers

listEventTriggers(
request: Message,
): Promise<MessageInit<BoundWorkflowEventTrigger>[]>
Parameters
- request: Message
Returns Promise<MessageInit<BoundWorkflowEventTrigger>[]>
- Defined in ../../src/workflow.ts:248

deleteEventTrigger

deleteEventTrigger(
request: DeleteWorkflowProviderEventTriggerRequest,
): Promise<void>
Parameters
- request: DeleteWorkflowProviderEventTriggerRequest
Returns Promise<void>
- Defined in ../../src/workflow.ts:254

pauseEventTrigger

pauseEventTrigger(
request: PauseWorkflowProviderEventTriggerRequest,
): Promise<MessageInit<BoundWorkflowEventTrigger>>
Parameters
- request: PauseWorkflowProviderEventTriggerRequest
Returns Promise<MessageInit<BoundWorkflowEventTrigger>>
- Defined in ../../src/workflow.ts:260

resumeEventTrigger

resumeEventTrigger(
request: ResumeWorkflowProviderEventTriggerRequest,
): Promise<MessageInit<BoundWorkflowEventTrigger>>
Parameters
- request: ResumeWorkflowProviderEventTriggerRequest
Returns Promise<MessageInit<BoundWorkflowEventTrigger>>
- Defined in ../../src/workflow.ts:266

publishEvent

publishEvent(request: PublishWorkflowProviderEventRequest): Promise<void>
Parameters
- request: PublishWorkflowProviderEventRequest
Returns Promise<void>
- Defined in ../../src/workflow.ts:272