Skip to content

Job

Work in progress

This api is still being built and is subject to change

class Job(AbstractSubmission):
    def __init__(self, name: str, pool, batch_name: str = None, **kwargs):

This is an abstract class and the base class of all available deadline jobs.

Attributes

Name Type Description
name str The name of the job Mandatory
pool str The name of the deadline pool to submit the job too Mandatory
batch_name str The name of the batch submission this job belongs to Optional
priority int Higher numbers will render first. Range of 0-99. Defaults to 50. Optional
comment str A helpful tag to identify the job. Defaults to "" Optional
chunk_size int The number of frames per task. Defaults to 1 Optional
job_dependencies list A list of Jobs either represented by a Job object or a uuid. Defaults to [None] Optional

Properties

Name Type Description
plugin list The deadline plugin that will execute this job
type str Human-readable identifier to specify the job type
deadline_uuid str The deadline job number if the job has been submitted
files list The auxillary files to be submitted with this job
paths list A list of output paths that can be accessed through deadline monitor

Methods

submit()

Submit the job to deadline.

Returns:

Name Type Description
deadline_uuid str The Deadline Job ID