qunicorn_core.api.job_api package

Submodules

qunicorn_core.api.job_api.job_view module

Module containing the routes of the job manager API.

class qunicorn_core.api.job_api.job_view.JobCancelView

Bases: MethodView

Jobs endpoint for a single job.

methods: t.ClassVar[t.Collection[str] | None] = {'POST'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

post(body, job_id: str)

Cancel a job execution via id.

class qunicorn_core.api.job_api.job_view.JobDetailView

Bases: MethodView

Jobs endpoint for a single job.

delete(body, job_id: str)

Delete job data via id.

get(job_id: str)

Get the details/results of a job.

methods: t.ClassVar[t.Collection[str] | None] = {'DELETE', 'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class qunicorn_core.api.job_api.job_view.JobIDView

Bases: MethodView

Jobs endpoint for collection of all jobs.

get()

Get registered job list.

methods: t.ClassVar[t.Collection[str] | None] = {'GET', 'POST'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

post(body)

Create/Register and run new job.

class qunicorn_core.api.job_api.job_view.JobPauseView

Bases: MethodView

Jobs endpoint for a single job.

methods: t.ClassVar[t.Collection[str] | None] = {'POST'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

post(body, job_id: str)

Pause a job via id.

class qunicorn_core.api.job_api.job_view.JobRunView

Bases: MethodView

Jobs endpoint for a single job.

methods: t.ClassVar[t.Collection[str] | None] = {'POST'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

post(body, job_id: str)

Run a job execution via id. tbd

qunicorn_core.api.job_api.root module

Module containing the root endpoint of the JobMANAGER API.

class qunicorn_core.api.job_api.root.RootData(root: str)

Bases: object

root: str

Module contents

Module containing the JobManager API.