dag-api / Exports / DagRuntimeController
Class: DagRuntimeController
API controller for DAG runtime operations: trigger, query, and cancel runs.
See
RunOrchestratorService
Table of contents
Constructors
Methods
Constructors
constructor
• new DagRuntimeController(runOrchestrator, runQuery, runCancel): DagRuntimeController
Parameters
| Name | Type |
|---|---|
runOrchestrator | RunOrchestratorService |
runQuery | RunQueryService |
runCancel | RunCancelService |
Returns
Defined in
controllers/dag-runtime-controller.ts:16
Methods
triggerRun
▸ triggerRun(request): Promise<TRuntimeApiResponse<{ dagRunId: string ; dagId: string ; version: number ; logicalDate: string ; taskRunIds: string[] }>>
Triggers a new DAG run with the specified definition and input.
Parameters
| Name | Type | Description |
|---|---|---|
request | ITriggerRunRequest | The trigger request with dagId, trigger type, and input. |
Returns
Promise<TRuntimeApiResponse<{ dagRunId: string ; dagId: string ; version: number ; logicalDate: string ; taskRunIds: string[] }>>
Created run details or problem details on error.
Defined in
controllers/dag-runtime-controller.ts:27
queryRun
▸ queryRun(request): Promise<TRuntimeApiResponse<{ dagRun: IDagRun ; taskRuns: ITaskRun[] }>>
Queries a DAG run and its associated task runs.
Parameters
| Name | Type | Description |
|---|---|---|
request | IQueryRunRequest | The query request with dagRunId. |
Returns
Promise<TRuntimeApiResponse<{ dagRun: IDagRun ; taskRuns: ITaskRun[] }>>
DAG run with task runs or problem details on error.
Defined in
controllers/dag-runtime-controller.ts:69
cancelRun
▸ cancelRun(request): Promise<TRuntimeApiResponse<{ dagRunId: string ; status: "cancelled" }>>
Cancels an active DAG run.
Parameters
| Name | Type | Description |
|---|---|---|
request | ICancelRunRequest | The cancel request with dagRunId. |
Returns
Promise<TRuntimeApiResponse<{ dagRunId: string ; status: "cancelled" }>>
Cancellation confirmation or problem details on error.