OCP App SDK

---

OCP App SDK / JobApi

Interface: JobApi

Defined in: src/jobs/JobApi.ts:71

Interface to trigger and monitor jobs

Methods

getDetail()

getDetail(jobId): Promise<JobDetail>

Defined in: src/jobs/JobApi.ts:73

Parameters

jobId

string

Returns

Promise<JobDetail>

---

getStatus()

getStatus(jobId): Promise<JobRunStatus>

Defined in: src/jobs/JobApi.ts:74

Parameters

jobId

string

Returns

Promise<JobRunStatus>

---

trigger()

trigger(jobName, parameters): Promise<JobDetail>

Defined in: src/jobs/JobApi.ts:72

Parameters

jobName

string

parameters

ValueHash

Returns

Promise<JobDetail>