Job class

class starfish.job.Job(job_id: str, status: Optional[str] = None, outputs: Optional[Any] = None, error: Optional[Any] = None)

Bases: Generic[starfish.types.Job]

Create a Job object

Parameters
  • agent (Agent object to assign to this Listing) – agent object that created the listing.

  • job_id (str) – id of the job.

static create_from_result(job_id: str, result: dict) starfish.types.Job
property error: Any

Return the ouptuts for this job

Returns

results

Type

dict or None

property is_done: bool
property is_working: bool
property job_id: str

Return the job id

Returns

Job id

Type

int

property outputs: Any

Return the ouptuts for this job

Returns

results

Type

dict or None

property result

Return the job result of a completed job. If the job is not completed then the ‘status’ will contain the current job status.

Parameters

job_id (str) – Job id of the job to get the status.

Returns

Job status

Type

str

property status: str

Return the status for this job

Returns

status

Type

str