dag-designer / Exports / IDesignerApiClient
Interface: IDesignerApiClient
Implemented by
Table of contents
Properties
Methods
- createDefinition
- updateDraft
- validateDefinition
- publishDefinition
- getDefinition
- listDefinitions
- listObjectInfo
- createRun
- startRun
- getRunResult
Properties
subscribeRunProgress
• subscribeRunProgress: (input: ISubscribeRunProgressInput) => () => void
Type declaration
▸ (input): () => void
Parameters
| Name | Type |
|---|---|
input | ISubscribeRunProgressInput |
Returns
fn
▸ (): void
Returns
void
Defined in
dag-designer/src/contracts/designer-api.ts:81
Methods
createDefinition
▸ createDefinition(input): Promise<TResult<IDagDefinition, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | ICreateDefinitionInput |
Returns
Promise<TResult<IDagDefinition, IProblemDetails[]>>
Defined in
dag-designer/src/contracts/designer-api.ts:71
updateDraft
▸ updateDraft(input): Promise<TResult<IDagDefinition, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | IUpdateDraftInput |
Returns
Promise<TResult<IDagDefinition, IProblemDetails[]>>
Defined in
dag-designer/src/contracts/designer-api.ts:72
validateDefinition
▸ validateDefinition(input): Promise<TResult<IDagDefinition, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | IValidateDefinitionInput |
Returns
Promise<TResult<IDagDefinition, IProblemDetails[]>>
Defined in
dag-designer/src/contracts/designer-api.ts:73
publishDefinition
▸ publishDefinition(input): Promise<TResult<IDagDefinition, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | IPublishDefinitionInput |
Returns
Promise<TResult<IDagDefinition, IProblemDetails[]>>
Defined in
dag-designer/src/contracts/designer-api.ts:74
getDefinition
▸ getDefinition(input): Promise<TResult<IDagDefinition, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | IGetDefinitionInput |
Returns
Promise<TResult<IDagDefinition, IProblemDetails[]>>
Defined in
dag-designer/src/contracts/designer-api.ts:75
listDefinitions
▸ listDefinitions(input?): Promise<TResult<IDefinitionListItem[], IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input? | IListDefinitionsInput |
Returns
Promise<TResult<IDefinitionListItem[], IProblemDetails[]>>
Defined in
dag-designer/src/contracts/designer-api.ts:76
listObjectInfo
▸ listObjectInfo(): Promise<TResult<TObjectInfo, IProblemDetails[]>>
Returns
Promise<TResult<TObjectInfo, IProblemDetails[]>>
Defined in
dag-designer/src/contracts/designer-api.ts:77
createRun
▸ createRun(input): Promise<TResult<{ preparationId: string }, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | IDesignerCreateRunInput |
Returns
Promise<TResult<{ preparationId: string }, IProblemDetails[]>>
Defined in
dag-designer/src/contracts/designer-api.ts:78
startRun
▸ startRun(input): Promise<TResult<{ dagRunId: string }, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | IDesignerStartRunInput |
Returns
Promise<TResult<{ dagRunId: string }, IProblemDetails[]>>
Defined in
dag-designer/src/contracts/designer-api.ts:79
getRunResult
▸ getRunResult(input): Promise<TResult<IRunResult, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | IGetRunResultInput |
Returns
Promise<TResult<IRunResult, IProblemDetails[]>>