Jobs.Jobs Class Reference

Public Member Functions
def	AddSlavesToJobMachineLimitList (self, id, slaveList)
def	AppendJobFrameRange (self, id, frameList)
def	ArchiveJob (self, id)
def	CompleteJob (self, id)
def	DeleteJob (self, id)
def	FailJob (self, id)
def	GetDeletedJobIDs (self)
def	GetDeletedJobs (self, ids=None)
def	GetJob (self, id)
def	GetJobDetails (self, ids)
def	GetJobIds (self)
def	GetJobs (self, ids=None)
def	GetJobsInState (self, state)
def	GetJobsInStates (self, states)
def	ImportJob (self, file)
def	PendJob (self, id)
def	PurgeDeletedJobs (self, ids)
def	ReleasePendingJob (self, id)
def	RemoveSlavesFromJobMachineLimitList (self, id, slaveList)
def	RequeueJob (self, id)
def	ResumeFailedJob (self, id)
def	ResumeJob (self, id)
def	SaveJob (self, jobData)
def	SetJobFrameRange (self, id, frameList, chunkSize)
def	SetJobMachineLimit (self, id, limit, slaveList, whiteListFlag)
def	SetJobMachineLimitListedSlaves (self, id, slaveList)
def	SetJobMachineLimitMaximum (self, id, limit)
def	SetJobMachineLimitWhiteListFlag (self, id, whiteListFlag)
def	SubmitJob (self, info, plugin, aux=[], idOnly=False)
def	SubmitJobFiles (self, info, plugin, aux=[], idOnly=False)
def	SubmitJobs (self, jobs=[], dependent=False)
def	SuspendJob (self, id)
def	SuspendJobNonRenderingTasks (self, id)
def	UndeleteJob (self, id)
def	UndeleteJobs (self, ids)
def	UpdateJobSubmissionDate (self, id)

Detailed Description

    Class used by DeadlineCon to send Job requests. 
    Stores the address of the Web Service for use in sending requests.

Member Function Documentation

AddSlavesToJobMachineLimitList()

def Jobs.Jobs.AddSlavesToJobMachineLimitList	(		self,
			id,
			slaveList
	)

    Add additional Workers to the Jobs limit list.
    Input:  id: The Job ID.
    slaveList: The Workers to be added to the Jobs machine limit list.
    Returns: Success message.

AppendJobFrameRange()

def Jobs.Jobs.AppendJobFrameRange	(		self,
			id,
			frameList
	)

    Appends to a Job's frame range without affecting the existing Tasks. The only exception is if the Job's chunk size is greater than one, and the last Task is having frames appended to it.
    Input: id: The Job ID.
    frameList: The additional frames to append.
    Returns: Success message.

ArchiveJob()

def Jobs.Jobs.ArchiveJob	(		self,
			id
	)

    Archive a non-queued, non-rendering Job.
    Input: id: The Job ID.
    Returns: Success message.

CompleteJob()

def Jobs.Jobs.CompleteJob	(		self,
			id
	)

    Completes a Job. All incomplete Tasks for the Job will be marked as complete.
    Input: id: The Job ID.
    Returns: Success message.

DeleteJob()

def Jobs.Jobs.DeleteJob	(		self,
			id
	)

    Deletes a Job.
    Input: id: The Job ID.
    Returns: Success message.

FailJob()

def Jobs.Jobs.FailJob	(		self,
			id
	)

    Fails a Job. All incomplete Tasks for the Job will be marked as failed.
    Input: id: The Job ID.
    Returns: Success message.

GetDeletedJobIDs()

def Jobs.Jobs.GetDeletedJobIDs

(

self

)

    Gets all the deleted Job IDs.
    Returns: The list of deleted Job IDs.

GetDeletedJobs()

def Jobs.Jobs.GetDeletedJobs	(		self,
			ids = None
	)

 Gets the undeleted Jobs that correspond to the provided Job IDs. If no IDs are provided, gets all the deleted Jobs.
    Input: The Job IDs (optional, may be a list).
    Returns: The Job/s (list).

GetJob()

def Jobs.Jobs.GetJob	(		self,
			id
	)

Gets a Job.
    Input: id: The Job ID (may be a list).
    Returns: The Job/s (list).

GetJobDetails()

def Jobs.Jobs.GetJobDetails	(		self,
			ids
	)

 Gets the Job details for the provided Job IDs.
    Input: The Job IDs (may be a list).
    Returns: The Job Details for the valid Job IDs provided.

GetJobIds()

def Jobs.Jobs.GetJobIds

(

self

)

    Gets all the Job IDs.
    Returns: The list of IDs.

GetJobs()

def Jobs.Jobs.GetJobs	(		self,
			ids = None
	)

    Gets all specified Jobs, or all Jobs if none specified.
    Input: List of Job Ids.
    Returns: The list of Jobs.

GetJobsInState()

def Jobs.Jobs.GetJobsInState	(		self,
			state
	)

    Gets all jobs in the specified state.
    Input: The state. Valid states are Active, Suspended, Completed, Failed, and Pending. Note that Active covers both Queued and Rendering jobs.
    Returns: The list of Jobs in the specified state.

GetJobsInStates()

def Jobs.Jobs.GetJobsInStates	(		self,
			states
	)

    Gets all jobs in the specified states.
    Input: The list of states. Valid states are Active, Suspended, Completed, Failed, and Pending. Note that Active covers both Queued and Rendering jobs.
    Returns: The list of Jobs in the specified states.

ImportJob()

def Jobs.Jobs.ImportJob	(		self,
			file
	)

    Imports an archived Job and returns it.
    Input: file: file location for archived Job.
    Returns: Success message.

PendJob()

def Jobs.Jobs.PendJob	(		self,
			id
	)

    Place a Job with dependencies in the pending state.
    Input: id: The Job ID.
    Returns: Success message.

PurgeDeletedJobs()

def Jobs.Jobs.PurgeDeletedJobs	(		self,
			ids
	)

 Purges the deleted Jobs that correspond to the provided IDs from the deleted Job collection.
    Input: The deleted Job IDs (may be a list).
    Returns: Success message.

ReleasePendingJob()

def Jobs.Jobs.ReleasePendingJob	(		self,
			id
	)

    Releases a pending Job.
    Input: id: The Job ID.
    Returns: Success message.

RemoveSlavesFromJobMachineLimitList()

def Jobs.Jobs.RemoveSlavesFromJobMachineLimitList	(		self,
			id,
			slaveList
	)

    Remove chosen Workers from the Jobs limit list.
    Input: id: The Job ID.
   slaveList: The Workers to be removed from the Jobs machine limit list.
    Returns: Success message.

RequeueJob()

def Jobs.Jobs.RequeueJob	(		self,
			id
	)

    Requeues a Job. All rendering and completed Tasks for the Job will be requeued.
    Input: id: The Job ID.
    Returns: Success message.

ResumeFailedJob()

def Jobs.Jobs.ResumeFailedJob	(		self,
			id
	)

    Resumes a failed Job.
    Input: id: The Job ID.
    Returns: Success message.

ResumeJob()

def Jobs.Jobs.ResumeJob	(		self,
			id
	)

    Resumes a job.
    Input: id: The Job ID.
    Returns: Success message.

SaveJob()

def Jobs.Jobs.SaveJob	(		self,
			jobData
	)

    Updates a Job's properties in the database.
    Input: jobData: The Jobs information in json format.
    Returns: Success message.

SetJobFrameRange()

def Jobs.Jobs.SetJobFrameRange	(		self,
			id,
			frameList,
			chunkSize
	)

    Modifies a Job's frame range. If the Job is currently being rendered, any rendering Tasks will be requeued to perform this operation.
    Input: id: The Job ID.
    frameList: The frame list.
    chunkSize: The chunk size.
    Returns: Success message.

SetJobMachineLimit()

def Jobs.Jobs.SetJobMachineLimit	(		self,
			id,
			limit,
			slaveList,
			whiteListFlag
	)

    Sets a Job's machine limit.
    Input:  id: The Job ID.
            limit: The maximum number of Workers that can work on this Job at any one time.
            slaveList: A list of Workers which are either not allowed to work on or are the only allowed Worker for a Job.
            whiteListFlag: If true the Workers in the slaveList are the only Workers allowed to work on the Job else, the Workers are now allowed to work on the Job.
    Returns: Success message.

SetJobMachineLimitListedSlaves()

def Jobs.Jobs.SetJobMachineLimitListedSlaves	(		self,
			id,
			slaveList
	)

    Sets a Job's machine limit Worker list.
    Input:  id: The Job ID.
    slaveList: A list of Workers which are either not allowed to work on or are the only allowed Worker for a Job.
    Returns: Success message.

SetJobMachineLimitMaximum()

def Jobs.Jobs.SetJobMachineLimitMaximum	(		self,
			id,
			limit
	)

    Sets a Job's machine limit maximum number of Workers.
    Input:  id: The Job ID.
    limit: The maximum number of Workers that can work on this Job at any one time.
    Returns: Success message.

SetJobMachineLimitWhiteListFlag()

def Jobs.Jobs.SetJobMachineLimitWhiteListFlag	(		self,
			id,
			whiteListFlag
	)

    Sets a Job's machine limit allow list flag.
    Input:  id: The Job ID.
    whiteListFlag: If true the Workers in the slaveList are the only Workers allowed to work on the Job else, the Workers are now allowed to work on the Job.
    Returns: Success message.

SubmitJob()

def Jobs.Jobs.SubmitJob	(		self,
			info,
			plugin,
			aux = [],
			idOnly = False
	)

    Submit a new Job.
    Input:  info: Dictionary of Job information.
            plugin: Dictionary of Plugin information for the Job.
            aux: Array of any additional auxiliary submission files, defaults to empty.
            idOnly: If True, only the Job's ID is returned, defaults to False.
    Returns: The new Job.

SubmitJobFiles()

def Jobs.Jobs.SubmitJobFiles	(		self,
			info,
			plugin,
			aux = [],
			idOnly = False
	)

    Submit a new Job using Job info file and plugin info file.
    Input:  info: The location of the Job Info File.
            plugin: The location of the Plugin Info File.
            aux: Array of any additional auxiliary submission files, defaults to empty.
            idOnly: If True, only the Job's ID is returned, defaults to False.
    Returns: The new Job.

SubmitJobs()

def Jobs.Jobs.SubmitJobs	(		self,
			jobs = [],
			dependent = False
	)

    Submits multiple Jobs.
    Input:  jobs: List of Jobs as dictionaries. Job dictionaries should contain the following properties:
                JobInfo - Dictionary of Job information. Required property.
                PluginInfo - Dictionary of Plugin information for the Job. Required property.
                AuxFiles - List of any additional auxiliary submission files (defaults to empty). Required property.
                DependsOnPrevious - True to make the Job dependent on the previously submitted Job. Defaults to false.
            dependent: True to make each Job submitted dependent on the previous (except for the first one). Defaults to false.
    Returns: Success message.

SuspendJob()

def Jobs.Jobs.SuspendJob	(		self,
			id
	)

    Suspend a queued, rendering, or pending job.
    Input: id: The Job ID.
    Returns: Success message.

SuspendJobNonRenderingTasks()

def Jobs.Jobs.SuspendJobNonRenderingTasks	(		self,
			id
	)

 Suspends the Tasks for a Job that are not in the rendering state.
    Input: id: The Job ID.
    Returns: Success message.

UndeleteJob()

def Jobs.Jobs.UndeleteJob	(		self,
			id
	)

    Undeletes deleted Job.
    Input: id: The Job ID.
    Returns: Success message.

UndeleteJobs()

def Jobs.Jobs.UndeleteJobs	(		self,
			ids
	)

    Undeletes deleted Jobs.
    Input: id: The Job IDs.
    Returns: Success message.

UpdateJobSubmissionDate()

def Jobs.Jobs.UpdateJobSubmissionDate	(		self,
			id
	)

    Sets the Job's submission date to the current time.
    Input: id: The Jobs ID.
    Returns: Success message.