OCP App SDK / JobApi

JobApi

Interface to trigger and monitor jobs

Index

Methods

• getDetail
• getStatus
• trigger

Methods

getDetail()

Signature

getDetail(jobId: string): Promise<JobDetail>;

Parameters

Returns

Promise<JobDetail>

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

getStatus()

Signature

getStatus(jobId: string): Promise<JobRunStatus>;

Parameters

Returns

Promise<JobRunStatus>

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

trigger()

Signature

trigger(jobName: string, parameters: ValueHash): Promise<JobDetail>;

Parameters

Returns

Promise<JobDetail>

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