Survey Job

class pyrefinebio.SurveyJob(id=None, source_type=None, success=None, ram_amount=None, start_time=None, end_time=None, batch_job_id=None, batch_job_queue=None, created_at=None, last_modified=None, is_queued=None)

Survey Job.

Retrieve a SurveyJob by id

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

Retrieve a list of SurveyJobs based on filters

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

Retrieve a SurveyJob based on id

Returns:

SurveyJob

Parameters:

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

classmethod search(**kwargs)

Retrieve a list of SurveyJobs based on various filters

Returns:

list of SurveyJob

Keyword Arguments:

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

  • source_type (str) – filter based on the name of the source database

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

  • ram_amount (int) – filter based on the amount of ram assigned to 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.