Class WorkflowClient

Index

Constructors

Methods

applyDefinition getDefinition listDefinitions setDefinitionPaused setActivationPaused deleteDefinition startRun listRuns getRun getRunEvents getRunOutput cancelRun signalRun signalOrStartRun

Constructors

constructor

new WorkflowClient(transport: Transport): WorkflowClient
Parameters
- transport: Transport
Returns WorkflowClient

Methods

applyDefinition

applyDefinition(
request: PublicWorkflowApplyDefinitionRequest,
callOptions?: PublicUnaryCallOptions,
): Promise<WorkflowDefinition>
Parameters
- request: PublicWorkflowApplyDefinitionRequest
- OptionalcallOptions: PublicUnaryCallOptions
Returns Promise<WorkflowDefinition>

getDefinition

getDefinition(
request: PublicWorkflowGetDefinitionRequest,
callOptions?: PublicUnaryCallOptions,
): Promise<WorkflowDefinition>
Parameters
- request: PublicWorkflowGetDefinitionRequest
- OptionalcallOptions: PublicUnaryCallOptions
Returns Promise<WorkflowDefinition>

listDefinitions

listDefinitions(
request: PublicWorkflowListDefinitionsRequest,
callOptions?: PublicUnaryCallOptions,
): Promise<ListWorkflowProviderDefinitionsResponse>
Parameters
- request: PublicWorkflowListDefinitionsRequest
- OptionalcallOptions: PublicUnaryCallOptions
Returns Promise<ListWorkflowProviderDefinitionsResponse>

setDefinitionPaused

setDefinitionPaused(
request: PublicWorkflowSetDefinitionPausedRequest,
callOptions?: PublicUnaryCallOptions,
): Promise<WorkflowDefinition>
Parameters
- request: PublicWorkflowSetDefinitionPausedRequest
- OptionalcallOptions: PublicUnaryCallOptions
Returns Promise<WorkflowDefinition>

setActivationPaused

setActivationPaused(
request: PublicWorkflowSetActivationPausedRequest,
callOptions?: PublicUnaryCallOptions,
): Promise<WorkflowDefinition>
Parameters
- request: PublicWorkflowSetActivationPausedRequest
- OptionalcallOptions: PublicUnaryCallOptions
Returns Promise<WorkflowDefinition>

deleteDefinition

deleteDefinition(
request: PublicWorkflowDeleteDefinitionRequest,
callOptions?: PublicUnaryCallOptions,
): Promise<void>
Parameters
- request: PublicWorkflowDeleteDefinitionRequest
- OptionalcallOptions: PublicUnaryCallOptions
Returns Promise<void>

startRun

startRun(
request: PublicWorkflowStartRunRequest,
callOptions?: PublicUnaryCallOptions,
): Promise<WorkflowRun>
Parameters
- request: PublicWorkflowStartRunRequest
- OptionalcallOptions: PublicUnaryCallOptions
Returns Promise<WorkflowRun>

listRuns

listRuns(
request: PublicWorkflowListRunsRequest,
callOptions?: PublicUnaryCallOptions,
): Promise<ListWorkflowProviderRunsResponse>
Parameters
- request: PublicWorkflowListRunsRequest
- OptionalcallOptions: PublicUnaryCallOptions
Returns Promise<ListWorkflowProviderRunsResponse>

getRun

getRun(
request: PublicWorkflowGetRunRequest,
callOptions?: PublicUnaryCallOptions,
): Promise<WorkflowRun>
Parameters
- request: PublicWorkflowGetRunRequest
- OptionalcallOptions: PublicUnaryCallOptions
Returns Promise<WorkflowRun>

getRunEvents

getRunEvents(
request: PublicWorkflowGetRunEventsRequest,
callOptions?: PublicUnaryCallOptions,
): Promise<GetWorkflowProviderRunEventsResponse>
Parameters
- request: PublicWorkflowGetRunEventsRequest
- OptionalcallOptions: PublicUnaryCallOptions
Returns Promise<GetWorkflowProviderRunEventsResponse>

getRunOutput

getRunOutput(
request: PublicWorkflowGetRunOutputRequest,
callOptions?: PublicUnaryCallOptions,
): Promise<GetWorkflowProviderRunOutputResponse>
Parameters
- request: PublicWorkflowGetRunOutputRequest
- OptionalcallOptions: PublicUnaryCallOptions
Returns Promise<GetWorkflowProviderRunOutputResponse>

cancelRun

cancelRun(
request: PublicWorkflowCancelRunRequest,
callOptions?: PublicUnaryCallOptions,
): Promise<WorkflowRun>
Parameters
- request: PublicWorkflowCancelRunRequest
- OptionalcallOptions: PublicUnaryCallOptions
Returns Promise<WorkflowRun>

signalRun

signalRun(
request: PublicWorkflowSignalRunRequest,
callOptions?: PublicUnaryCallOptions,
): Promise<SignalWorkflowRunResponse>
Parameters
- request: PublicWorkflowSignalRunRequest
- OptionalcallOptions: PublicUnaryCallOptions
Returns Promise<SignalWorkflowRunResponse>

signalOrStartRun

signalOrStartRun(
request: PublicWorkflowSignalOrStartRunRequest,
callOptions?: PublicUnaryCallOptions,
): Promise<SignalWorkflowRunResponse>
Parameters
- request: PublicWorkflowSignalOrStartRunRequest
- OptionalcallOptions: PublicUnaryCallOptions
Returns Promise<SignalWorkflowRunResponse>