openprotein.jobs.Future#

class openprotein.jobs.Future(session, job)[source]#

Base class for all Futures returning results from a job.

Parameters:
  • session (APISession)

  • job (Job)

__init__(session, job)[source]#
Parameters:
  • session (APISession)

  • job (Job)

Methods

__init__(session, job)

cancelled()

Check if the job has been cancelled.

create(session[, job_id, job, response])

Create an instance of the appropriate Future class based on the job type.

done()

Check if the job has completed.

get([verbose])

Return the results from this job.

refresh()

Refresh the job status and internal job object.

wait([interval, timeout, verbose])

Wait for the job to complete, then fetch results.

wait_until_done([interval, timeout, verbose])

Wait for the job to complete.

Attributes

created_date

The creation timestamp of the job.

end_date

The end timestamp of the job.

id

The unique identifier of the job.

job_id

The unique identifier of the job.

job_type

The type of the job.

progress_counter

The progress counter of the job.

start_date

The start timestamp of the job.

status

The current status of the job.

session

job