dag-designer / Exports / IUseDagDesignApi
Interface: IUseDagDesignApi
Table of contents
Properties
- createDraft
- updateDraft
- validate
- publish
- load
- list
- listObjectInfo
- createRun
- startRun
- getRunResult
- subscribeRunProgress
Properties
createDraft
• createDraft: (input: { definition: IDagDefinition ; correlationId?: string }) => Promise<TResult<IDagDefinition, IProblemDetails[]>>
Type declaration
▸ (input): Promise<TResult<IDagDefinition, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | Object |
input.definition | IDagDefinition |
input.correlationId? | string |
Returns
Promise<TResult<IDagDefinition, IProblemDetails[]>>
Defined in
dag-designer/src/hooks/use-dag-design-api.ts:24
updateDraft
• updateDraft: (input: { dagId: string ; version: number ; definition: IDagDefinition ; correlationId?: string }) => Promise<TResult<IDagDefinition, IProblemDetails[]>>
Type declaration
▸ (input): Promise<TResult<IDagDefinition, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | Object |
input.dagId | string |
input.version | number |
input.definition | IDagDefinition |
input.correlationId? | string |
Returns
Promise<TResult<IDagDefinition, IProblemDetails[]>>
Defined in
dag-designer/src/hooks/use-dag-design-api.ts:28
validate
• validate: (input: { dagId: string ; version: number ; correlationId?: string }) => Promise<TResult<IDagDefinition, IProblemDetails[]>>
Type declaration
▸ (input): Promise<TResult<IDagDefinition, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | Object |
input.dagId | string |
input.version | number |
input.correlationId? | string |
Returns
Promise<TResult<IDagDefinition, IProblemDetails[]>>
Defined in
dag-designer/src/hooks/use-dag-design-api.ts:34
publish
• publish: (input: { dagId: string ; version: number ; correlationId?: string }) => Promise<TResult<IDagDefinition, IProblemDetails[]>>
Type declaration
▸ (input): Promise<TResult<IDagDefinition, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | Object |
input.dagId | string |
input.version | number |
input.correlationId? | string |
Returns
Promise<TResult<IDagDefinition, IProblemDetails[]>>
Defined in
dag-designer/src/hooks/use-dag-design-api.ts:39
load
• load: (input: { dagId: string ; version?: number ; correlationId?: string }) => Promise<TResult<IDagDefinition, IProblemDetails[]>>
Type declaration
▸ (input): Promise<TResult<IDagDefinition, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | Object |
input.dagId | string |
input.version? | number |
input.correlationId? | string |
Returns
Promise<TResult<IDagDefinition, IProblemDetails[]>>
Defined in
dag-designer/src/hooks/use-dag-design-api.ts:44
list
• list: (input?: { dagId?: string ; correlationId?: string }) => Promise<TResult<IDefinitionListItem[], IProblemDetails[]>>
Type declaration
▸ (input?): Promise<TResult<IDefinitionListItem[], IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input? | Object |
input.dagId? | string |
input.correlationId? | string |
Returns
Promise<TResult<IDefinitionListItem[], IProblemDetails[]>>
Defined in
dag-designer/src/hooks/use-dag-design-api.ts:49
listObjectInfo
• listObjectInfo: () => Promise<TResult<TObjectInfo, IProblemDetails[]>>
Type declaration
▸ (): Promise<TResult<TObjectInfo, IProblemDetails[]>>
Returns
Promise<TResult<TObjectInfo, IProblemDetails[]>>
Defined in
dag-designer/src/hooks/use-dag-design-api.ts:53
createRun
• createRun: (input: { definition: IDagDefinition ; input?: TPortPayload ; correlationId?: string }) => Promise<TResult<{ preparationId: string }, IProblemDetails[]>>
Type declaration
▸ (input): Promise<TResult<{ preparationId: string }, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | Object |
input.definition | IDagDefinition |
input.input? | TPortPayload |
input.correlationId? | string |
Returns
Promise<TResult<{ preparationId: string }, IProblemDetails[]>>
Defined in
dag-designer/src/hooks/use-dag-design-api.ts:54
startRun
• startRun: (input: { preparationId: string ; correlationId?: string }) => Promise<TResult<{ dagRunId: string }, IProblemDetails[]>>
Type declaration
▸ (input): Promise<TResult<{ dagRunId: string }, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | Object |
input.preparationId | string |
input.correlationId? | string |
Returns
Promise<TResult<{ dagRunId: string }, IProblemDetails[]>>
Defined in
dag-designer/src/hooks/use-dag-design-api.ts:59
getRunResult
• getRunResult: (input: { dagRunId: string ; correlationId?: string }) => Promise<TResult<IRunResult, IProblemDetails[]>>
Type declaration
▸ (input): Promise<TResult<IRunResult, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | Object |
input.dagRunId | string |
input.correlationId? | string |
Returns
Promise<TResult<IRunResult, IProblemDetails[]>>
Defined in
dag-designer/src/hooks/use-dag-design-api.ts:63
subscribeRunProgress
• subscribeRunProgress: (input: { preparationId: string ; onEvent: (event: TRunProgressEvent) => void ; onError?: (error: Error) => void ; maxReconnectAttempts?: number ; initialReconnectDelayMs?: number }) => () => void
Type declaration
▸ (input): () => void
Parameters
| Name | Type |
|---|---|
input | Object |
input.preparationId | string |
input.onEvent | (event: TRunProgressEvent) => void |
input.onError? | (error: Error) => void |
input.maxReconnectAttempts? | number |
input.initialReconnectDelayMs? | number |
Returns
fn
▸ (): void
Returns
void