boulderopalscaleup.QctrlScaleUpClient.get_jobs

*async* QctrlScaleUpClient.get_jobs(device_name=None, job_name=None, page=1, limit=10, sort_order=JobHistorySortOrder.CREATED_AT_DESC, statuses=None)

Retrieves all the jobs that have been previously executed on the given device.

Parameters

  • device_name (str) – The name of the device to filter the history by. Defaults to current.
  • job_name (str , optional) – The name of the job to filter the history by. Defaults to None.
  • page (int , optional) – The page number to retrieve. Defaults to 1.
  • limit (int , optional) – The number of jobs to retrieve per page. Defaults to 10.
  • sort_order (JobHistorySortOrder , optional) – The sort order for the results. Defaults to reverse chronological.
  • statuses (list [JobStatus ] or JobStatus or None , optional) – One or more statuses to filter by. Defaults to completed jobs only.

Returns

The history of jobs run.

Return type

list[JobSummary]

Raises

ScaleUpServerError – If the response is invalid.

Was this useful?