Processor Job

class pyrefinebio.ProcessorJob(id=None, pipeline_applied=None, num_retries=None, retried=None, worker_id=None, ram_amount=None, volume_index=None, worker_version=None, failure_reason=None, batch_job_id=None, batch_job_queue=None, success=None, original_files=[], datasets=None, start_time=None, end_time=None, created_at=None, last_modified=None, is_queued=None)

Processor Job.

Retrieve a ProcessorJob by id

>>> import pyrefinebio
>>> id = 1
>>> job = pyrefinebio.ProcessorJob.get(id)

Retrieve a list of ProcessorJobs based on filters

>>> import pyrefinebio
>>> jobs = pyrefinebio.ProcessorJob.search(num_retries=1)
classmethod get(id)

Retrieve a ProcessorJob based on id

Returns:

ProcessorJob

Parameters:

id (int) – the id for the ProcessorJob you want to get

classmethod search(**kwargs)

Retrieve a list of ProcessorJobs based on various filters

Returns:

list of ProcessorJob

Keyword Arguments:

  • id (int) – filter based on the id of the ProcessorJob

  • pipeline_applied (str) – filter based on the type of pipeline applied to the job

  • num_retries (int) – filter based on the number of times the job has retried

  • retried (bool) – filter based on if the job has retried

  • worker_id (str) – filter based on the id of the job’s worker

  • ram_amount (int) – filter based on the amount of ram assigned to the job

  • volume_index (str) –

  • worker_version (str) – filter based on the job’s worker version

  • failure_reason (str) – filter based on the reason why the job failed

  • batch_job_id (str) – filter based on the job’s batch id

  • success (bool) – filter based on if the job has succeeded

  • original_files (str) – filter based on the ids of the OriginalFiles associated with the job

  • datasets (str) – filter based on the ids of the Datasets associated with the job

  • start_time (str) – filter based on the time when the job started

  • end_time (str) – filter based on the time when the job finished

  • created_at (str) – filter based on the time when the job was created

  • last_modified (str) – filter based on the time when the job was last modified

  • ordering (str) – which field to use when ordering the results.

  • limit (int) – number of results to return per page.

  • offset (int) – the initial index from which to return the results.

  • sample_accession_code (str) – filter based on the samples associated with the job