JobsResource
Job API methods.
Job API methods.
Functions
constructor__init__(client) -> NoneInitialize the resource.
paramclientKitaruAPIClientAPI client used to send requests.
Returns
Nonefuncget(job_id) -> JobResponseGet a job by id.
paramjob_iduuid.UUIDId of the job.
Returns
kitaru.api_models.v1.job.JobResponseStored job.
funclist(params=None) -> Page[JobResponse]List jobs.
paramparamsJobListParams | None= NoneJob list params.
Returns
kitaru.api_models.v1.base.PagePage of jobs.
funciter(params=None) -> AsyncIterator[JobResponse]Iterate over all jobs.
paramparamsJobListParams | None= NoneJob list params.
Returns
collections.abc.AsyncIteratorAsync iterator over every job.
funclist_tasks(job_id, params=None) -> Page[TaskResponse]List the tasks of a job.
paramjob_iduuid.UUIDId of the job.
paramparamsJobTasksListParams | None= NoneJob tasks list params.
Returns
kitaru.api_models.v1.base.PagePage of tasks.
funciter_tasks(job_id, params=None) -> AsyncIterator[TaskResponse]Iterate over all tasks of a job.
paramjob_iduuid.UUIDId of the job.
paramparamsJobTasksListParams | None= NoneJob tasks list params.
Returns
collections.abc.AsyncIteratorAsync iterator over every task of the job.
funccancel(job_id) -> JobResponseRequest cancellation of a job.
paramjob_iduuid.UUIDId of the job.
Returns
kitaru.api_models.v1.job.JobResponseJob carrying the cancel request.
funcdelete(job_id) -> NoneDelete a settled job, cascading its tasks.
paramjob_iduuid.UUIDId of the job.
Returns
None