dag-designer / Exports / DesignerApiClient
Class: DesignerApiClient
Implements
Table of contents
Constructors
Methods
- createDefinition
- updateDraft
- validateDefinition
- publishDefinition
- getDefinition
- listDefinitions
- listObjectInfo
- createRun
- startRun
- getRunResult
- subscribeRunProgress
Constructors
constructor
• new DesignerApiClient(config): DesignerApiClient
Parameters
| Name | Type |
|---|---|
config | IDesignerApiClientConfig |
Returns
Defined in
dag-designer/src/client/designer-api-client.ts:93
Methods
createDefinition
▸ createDefinition(input): Promise<TResult<IDagDefinition, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | ICreateDefinitionInput |
Returns
Promise<TResult<IDagDefinition, IProblemDetails[]>>
Implementation of
IDesignerApiClient.createDefinition
Defined in
dag-designer/src/client/designer-api-client.ts:97
updateDraft
▸ updateDraft(input): Promise<TResult<IDagDefinition, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | IUpdateDraftInput |
Returns
Promise<TResult<IDagDefinition, IProblemDetails[]>>
Implementation of
IDesignerApiClient.updateDraft
Defined in
dag-designer/src/client/designer-api-client.ts:106
validateDefinition
▸ validateDefinition(input): Promise<TResult<IDagDefinition, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | IValidateDefinitionInput |
Returns
Promise<TResult<IDagDefinition, IProblemDetails[]>>
Implementation of
IDesignerApiClient.validateDefinition
Defined in
dag-designer/src/client/designer-api-client.ts:118
publishDefinition
▸ publishDefinition(input): Promise<TResult<IDagDefinition, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | IPublishDefinitionInput |
Returns
Promise<TResult<IDagDefinition, IProblemDetails[]>>
Implementation of
IDesignerApiClient.publishDefinition
Defined in
dag-designer/src/client/designer-api-client.ts:127
getDefinition
▸ getDefinition(input): Promise<TResult<IDagDefinition, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | IGetDefinitionInput |
Returns
Promise<TResult<IDagDefinition, IProblemDetails[]>>
Implementation of
IDesignerApiClient.getDefinition
Defined in
dag-designer/src/client/designer-api-client.ts:136
listDefinitions
▸ listDefinitions(input?): Promise<TResult<IDefinitionListItem[], IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input? | IListDefinitionsInput |
Returns
Promise<TResult<IDefinitionListItem[], IProblemDetails[]>>
Implementation of
IDesignerApiClient.listDefinitions
Defined in
dag-designer/src/client/designer-api-client.ts:146
listObjectInfo
▸ listObjectInfo(): Promise<TResult<TObjectInfo, IProblemDetails[]>>
Returns
Promise<TResult<TObjectInfo, IProblemDetails[]>>
Implementation of
IDesignerApiClient.listObjectInfo
Defined in
dag-designer/src/client/designer-api-client.ts:170
createRun
▸ createRun(input): Promise<TResult<{ preparationId: string }, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | IDesignerCreateRunInput |
Returns
Promise<TResult<{ preparationId: string }, IProblemDetails[]>>
Implementation of
Defined in
dag-designer/src/client/designer-api-client.ts:183
startRun
▸ startRun(input): Promise<TResult<{ dagRunId: string }, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | IDesignerStartRunInput |
Returns
Promise<TResult<{ dagRunId: string }, IProblemDetails[]>>
Implementation of
Defined in
dag-designer/src/client/designer-api-client.ts:210
getRunResult
▸ getRunResult(input): Promise<TResult<IRunResult, IProblemDetails[]>>
Parameters
| Name | Type |
|---|---|
input | IGetRunResultInput |
Returns
Promise<TResult<IRunResult, IProblemDetails[]>>
Implementation of
IDesignerApiClient.getRunResult
Defined in
dag-designer/src/client/designer-api-client.ts:236
subscribeRunProgress
▸ subscribeRunProgress(input): () => void
Parameters
| Name | Type |
|---|---|
input | ISubscribeRunProgressInput |
Returns
fn
▸ (): void
Returns
void
Implementation of
IDesignerApiClient.subscribeRunProgress