JobApi
OCP App SDK / JobApi
JobApi
Interface to trigger and monitor jobs
Index
Methods
Methods
getDetail()
Signature
getDetail(jobId: string): Promise<JobDetail>;
Parameters
| Name | Type |
|---|---|
jobId | string |
Returns
Promise<JobDetail>
Defined in: src/jobs/JobApi.ts:73
getStatus()
Signature
getStatus(jobId: string): Promise<JobRunStatus>;
Parameters
| Name | Type |
|---|---|
jobId | string |
Returns
Promise<JobRunStatus>
Defined in: src/jobs/JobApi.ts:74
trigger()
Signature
trigger(jobName: string, parameters: ValueHash): Promise<JobDetail>;
Parameters
| Name | Type |
|---|---|
jobName | string |
parameters | ValueHash |
Returns
Promise<JobDetail>
Defined in: src/jobs/JobApi.ts:72
Updated 3 months ago