@valon-technologies/gestalt
Preparing search index...
index
WorkflowProviderOptions
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
)
ProviderBaseOptions
WorkflowProviderOptions
Index
Properties
name?
display
Name?
description?
version?
configure?
health
Check?
warnings?
start?
close?
apply
Definition
get
Definition
list
Definitions
set
Definition
Paused
set
Activation
Paused
delete
Definition
start
Run
get
Run
list
Runs
get
Run
Events
get
Run
Output
cancel
Run
signal
Run
signal
Or
Start
Run
deliver
Event
Properties
Optional
name
name
?:
string
Optional
display
Name
displayName
?:
string
Optional
description
description
?:
string
Optional
version
version
?:
string
Optional
configure
configure
?:
ConfigureHandler
Optional
health
Check
healthCheck
?:
HealthCheckHandler
Optional
warnings
warnings
?:
string
[]
|
WarningsHandler
Optional
start
start
?:
StartHandler
Optional
close
close
?:
CloseHandler
apply
Definition
applyDefinition
:
(
request
:
ApplyWorkflowProviderDefinitionRequest
,
)
=>
MaybePromise
<
WorkflowDefinition
>
get
Definition
getDefinition
:
(
request
:
GetWorkflowProviderDefinitionRequest
,
)
=>
MaybePromise
<
WorkflowDefinition
>
list
Definitions
listDefinitions
:
(
request
:
ListWorkflowProviderDefinitionsRequest
,
)
=>
MaybePromise
<
ListWorkflowProviderDefinitionsResponse
|
readonly
WorkflowDefinition
[]
,
>
set
Definition
Paused
setDefinitionPaused
:
(
request
:
SetWorkflowProviderDefinitionPausedRequest
,
)
=>
MaybePromise
<
WorkflowDefinition
>
set
Activation
Paused
setActivationPaused
:
(
request
:
SetWorkflowProviderActivationPausedRequest
,
)
=>
MaybePromise
<
WorkflowDefinition
>
delete
Definition
deleteDefinition
:
(
request
:
DeleteWorkflowProviderDefinitionRequest
,
)
=>
MaybePromise
<
void
>
start
Run
startRun
:
(
request
:
StartWorkflowProviderRunRequest
,
)
=>
MaybePromise
<
WorkflowRun
>
get
Run
getRun
:
(
request
:
GetWorkflowProviderRunRequest
)
=>
MaybePromise
<
WorkflowRun
>
list
Runs
listRuns
:
(
request
:
ListWorkflowProviderRunsRequest
,
)
=>
MaybePromise
<
ListWorkflowProviderRunsResponse
|
readonly
WorkflowRun
[]
>
get
Run
Events
getRunEvents
:
(
request
:
GetWorkflowProviderRunEventsRequest
,
)
=>
MaybePromise
<
GetWorkflowProviderRunEventsResponse
|
readonly
WorkflowRunEvent
[]
,
>
get
Run
Output
getRunOutput
:
(
request
:
GetWorkflowProviderRunOutputRequest
,
)
=>
MaybePromise
<
JsonInput
|
GetWorkflowProviderRunOutputResponse
>
cancel
Run
cancelRun
:
(
request
:
CancelWorkflowProviderRunRequest
,
)
=>
MaybePromise
<
WorkflowRun
>
signal
Run
signalRun
:
(
request
:
SignalWorkflowProviderRunRequest
,
)
=>
MaybePromise
<
SignalWorkflowRunResponse
>
signal
Or
Start
Run
signalOrStartRun
:
(
request
:
SignalOrStartWorkflowProviderRunRequest
,
)
=>
MaybePromise
<
SignalWorkflowRunResponse
>
deliver
Event
deliverEvent
:
(
request
:
DeliverWorkflowProviderEventRequest
,
)
=>
MaybePromise
<
WorkflowEvent
>
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Properties
name
display
Name
description
version
configure
health
Check
warnings
start
close
apply
Definition
get
Definition
list
Definitions
set
Definition
Paused
set
Activation
Paused
delete
Definition
start
Run
get
Run
list
Runs
get
Run
Events
get
Run
Output
cancel
Run
signal
Run
signal
Or
Start
Run
deliver
Event
@valon-technologies/gestalt
Loading...
Shared provider metadata and lifecycle hooks for authored providers.