AlgorithmJob

class AlgorithmJob(function, *args, **kwargs)

Bases: PrimitiveJob

This class is introduced for typing purposes and provides no additional function beyond that inherited from its parents.

Parameters:

function – A callable function to execute the job.

Methods

cancel()

Attempt to cancel the job.

cancelled()

Return whether the job has been cancelled.

Return type:

bool

done()

Return whether the job has successfully run.

Return type:

bool

in_final_state()

Return whether the job is in a final job state such as DONE or ERROR.

Return type:

bool

job_id()

Return a unique id identifying the job.

Return type:

str

result()

Return the results of the job.

Return type:

ResultT

running()

Return whether the job is actively running.

Return type:

bool

status()

Return the status of the job.

Return type:

JobStatus