Skip to content

microservice-job-broker


Class: JobBrokerService

Defined in: packages/microservice/job-broker/src/job-broker.service.ts:12

Aggregates and exposes job/task listings from MongoDB collections.

Constructors

Constructor

new JobBrokerService(quantificationJobModel, executableJobModel): JobBrokerService

Defined in: packages/microservice/job-broker/src/job-broker.service.ts:18

Construct the service with MongoDB models for job/task listings.

Parameters

quantificationJobModel

Model<QuantificationJobReport>

Mongoose model for quantification job documents

executableJobModel

Model<ExecutableJobReport>

Mongoose model for executable task documents

Returns

JobBrokerService

Methods

createJob()

createJob(): JobResponse

Defined in: packages/microservice/job-broker/src/job-broker.service.ts:97

Creates a new job.

Returns

JobResponse

An object containing a message confirming the creation of a new job.


getCompletedJobs()

getCompletedJobs(): Promise<{ jobs: QuantificationJobReport[]; tasks: ExecutableJobReport[]; }>

Defined in: packages/microservice/job-broker/src/job-broker.service.ts:82

Retrieves the list of completed jobs.

Returns

Promise<{ jobs: QuantificationJobReport[]; tasks: ExecutableJobReport[]; }>

Quantification jobs and executable tasks that have completed.


getJobs()

getJobs(status): Promise<{ jobs: QuantificationJobReport[]; tasks: ExecutableJobReport[]; }>

Defined in: packages/microservice/job-broker/src/job-broker.service.ts:37

Retrieves jobs and tasks filtered by status.

Parameters

status

string

The status to filter by (e.g., "pending", "queued", "completed").

Returns

Promise<{ jobs: QuantificationJobReport[]; tasks: ExecutableJobReport[]; }>

A list of quantification jobs and executable tasks matching the given status.


getJobTypes()

getJobTypes(): JobResponse

Defined in: packages/microservice/job-broker/src/job-broker.service.ts:27

Retrieves the types of jobs available.

Returns

JobResponse

An object containing a message describing the types of jobs.


getPendingJobs()

getPendingJobs(): Promise<{ jobs: QuantificationJobReport[]; tasks: ExecutableJobReport[]; }>

Defined in: packages/microservice/job-broker/src/job-broker.service.ts:52

Retrieves the list of pending jobs.

Returns

Promise<{ jobs: QuantificationJobReport[]; tasks: ExecutableJobReport[]; }>

An object containing a message describing the pending jobs.


getQueuedJobs()

getQueuedJobs(): Promise<{ jobs: QuantificationJobReport[]; tasks: ExecutableJobReport[]; }>

Defined in: packages/microservice/job-broker/src/job-broker.service.ts:67

Retrieves the list of queued jobs.

Returns

Promise<{ jobs: QuantificationJobReport[]; tasks: ExecutableJobReport[]; }>

Quantification jobs and executable tasks queued for execution.