Deadline Scripting Reference  10.0.29.0
Deadline.Jobs.Job Class Reference

A job. More...

Inherits LastWriteDocument, and IComparable.

Public Member Functions

void DeleteJobEnvironmentKey (string key)
 Deletes the environment variable for the given key. More...
 
void DeleteJobExtraInfoKey (string key)
 Deletes the extra info for the given key. More...
 
string [] GetJobEnvironmentKeys ()
 Gets the keys for the job's environment variable entries. More...
 
string GetJobEnvironmentKeyValue (string key)
 Gets the environment variable value for the given key. More...
 
string [] GetJobExtraInfoKeys ()
 Gets the keys for the job's extra info entries. More...
 
string GetJobExtraInfoKeyValue (string key)
 Gets the extra info value for the given key. More...
 
string GetJobExtraInfoKeyValueWithDefault (string key, string defaultValue)
 Gets the extra info value for the given key. More...
 
string [] GetJobInfoKeys ()
 Gets the job info keys. More...
 
string GetJobInfoKeyValue (string key)
 Get the job infor value for the provided key. More...
 
string [] GetJobPluginInfoKeys ()
 Gets the keys for the job's plugin info entries. More...
 
string GetJobPluginInfoKeyValue (string key)
 Gets the plugin info value for the given key. More...
 
void SetJobDependencyIDs (object jobIds)
 Sets the IDs of the jobs that this job is dependent on. More...
 
void SetJobEnvironmentKeyValue (string key, string value)
 Sets the environment variable value for the given key. More...
 
void SetJobExtraInfoKeyValue (string key, string value)
 Sets the extra info value for the given key. More...
 
void SetJobLimitGroups (object limitGroups)
 Sets the limit groups the job requires. More...
 
void SetJobNotificationEmails (object emails)
 Sets the arbitrary email addresses to send notifications to when this job is complete. More...
 
void SetJobNotificationTargets (object userNames)
 Sets the list of users that are to be notified when this job is complete. More...
 
void SetJobPluginInfoKeyValue (string key, string value)
 Sets the plugin info value for the given key. More...
 
void SetJobRequiredAssets (object assets)
 Sets the assets that are required in order to render this job. The assets should contain absolute paths. More...
 
void SetScriptDependencies (object scripts)
 Sets the scripts that must return True in order to render this job. More...
 

Static Public Attributes

static TimeSpan DisabledScheduleTime = TimeSpan.MinValue
 Represents a disabled scheduled time for custom job scheduling settings. More...
 

Properties

string [] JobAuxiliarySubmissionFileNames [get]
 The auxiliary files submitted with the job. More...
 
string JobBatchName [get, set]
 The name of the Batch that this job belongs to. More...
 
string JobComment [get, set]
 A brief comment about the job. More...
 
DateTime JobCompletedDateTime [get]
 The date/time at which the job finished rendering. More...
 
int JobCompletedTasks [get]
 The number of tasks in the completed state. More...
 
int JobConcurrentTasks [get, set]
 The maximum number of concurrent tasks a slave can dequeue for this job at a time. The value must be between 1 and 16 inclusive. More...
 
string JobCustomEventPluginDirectory [get, set]
 A custom location to load the job's event plugin from. More...
 
string JobCustomPluginDirectory [get, set]
 A custom location to load the job's plugin from. More...
 
string JobDepartment [get, set]
 The department to which the job's user belongs to. More...
 
string [] JobDependencyIDs [get]
 The ids of the jobs that this job is dependent on. More...
 
float JobDependencyPercentageValue [get, set]
 This job will resume when its dependencies have completed this percentage of their tasks. More...
 
bool JobEmailNotification [get, set]
 If overriding the user's notification method, whether to use email notification. More...
 
bool JobEnableAutoTimeout [get, set]
 The Auto Task Timeout feature is based on the Auto Job Timeout Settings in the Repository Options. The timeout is based on the render times of the tasks that have already finished for this job, so this option should only be used if the frames for the job have consistent render times. More...
 
bool JobEnableFrameTimeouts [get, set]
 If the timeouts are Frame based instead of Task based. More...
 
bool JobEnableTimeoutsForScriptTasks [get, set]
 If the timeouts should apply to pre/post job script tasks. More...
 
string JobExtraInfo0 [get, set]
 One of the Job's ten Extra Info fields More...
 
string JobExtraInfo1 [get, set]
 One of the Job's ten Extra Info fields More...
 
string JobExtraInfo2 [get, set]
 One of the Job's ten Extra Info fields More...
 
string JobExtraInfo3 [get, set]
 One of the Job's ten Extra Info fields More...
 
string JobExtraInfo4 [get, set]
 One of the Job's ten Extra Info fields More...
 
string JobExtraInfo5 [get, set]
 One of the Job's ten Extra Info fields More...
 
string JobExtraInfo6 [get, set]
 One of the Job's ten Extra Info fields More...
 
string JobExtraInfo7 [get, set]
 One of the Job's ten Extra Info fields More...
 
string JobExtraInfo8 [get, set]
 One of the Job's ten Extra Info fields More...
 
string JobExtraInfo9 [get, set]
 One of the Job's ten Extra Info fields More...
 
int JobFailedTasks [get]
 The number of tasks in the failed state. More...
 
int JobFailureDetectionJobErrors [get, set]
 If JobOverrideJobFailureDetection is enabled, this is the number of errors it takes to trigger a job failure. More...
 
int JobFailureDetectionTaskErrors [get, set]
 If JobOverrideTaskFailureDetection is enabled, this is the number of errors it takes to trigger a task failure. More...
 
bool JobForceReloadPlugin [get, set]
 Whether or not the job's plugin should be reloaded between tasks. More...
 
int JobFrameDependencyOffsetEnd [get, set]
 The end offset for frame depenencies. More...
 
int JobFrameDependencyOffsetStart [get, set]
 The start offset for frame depenencies. More...
 
string JobFrames [get]
 The job's frame list as a string. More...
 
int [] JobFramesList [get]
 The job's frame list as an array. More...
 
int JobFramesPerTask [get]
 The number of frames per task. More...
 
TimeSpan JobFridayStartTime [get, set]
 Gets or sets Friday's start time. More...
 
TimeSpan JobFridayStopTime [get, set]
 Gets or sets Friday's stop time. More...
 
string JobGroup [get, set]
 The job's group. More...
 
string JobId [get]
 The job's ID. More...
 
bool JobIgnoreBadSlaveDetection [get, set]
 Whether or not this job overrides the Bad Slave Detection settings in the Repository Options. More...
 
int JobInitializePluginTimeoutSeconds [get, set]
 The timespan a job's task has to start before a timeout occurs. More...
 
bool JobInterruptible [get, set]
 If the job is interruptible, which causes it to be canceled when a job with higher priority comes along. More...
 
int JobInterruptiblePercentage [get, set]
 The completion percentage that this Job must be less than in order to be interruptible More...
 
bool JobIsFrameDependent [get, set]
 If the job is frame dependent. More...
 
string [] JobLimitGroups [get]
 The limit groups the job requires. More...
 
bool JobLimitTasksToNumberOfCpus [get, set]
 Whether or not the number of concurrent tasks a slave can dequeue for this job should be limited to the number of CPUs the slave has. More...
 
string [] JobListedSlaves [get]
 The list of black/white listed slaves for the job. Use JobWhitelistFlag to determine if the list is a blacklist or a whitelist. More...
 
int JobMachineLimit [get]
 The machine limit for the job. More...
 
double JobMachineLimitProgress [get]
 When the slave reaches this progress for the job's task, it will release the limit group. More...
 
bool JobMaintenanceJob [get]
 If this is a maintenance job. More...
 
int JobMaintenanceJobEndFrame [get]
 The start frame for a maintenance job. More...
 
int JobMaintenanceJobStartFrame [get]
 The start frame for a maintenance job. More...
 
int JobMinRenderTimeSeconds [get, set]
 The minimum number of seconds a job must run to be considered successful. More...
 
TimeSpan JobMondayStartTime [get, set]
 Gets or sets Monday's start time. More...
 
TimeSpan JobMondayStopTime [get, set]
 Gets or sets Monday's stop time. More...
 
string JobName [get, set]
 The job's name. More...
 
string [] JobNotificationEmails [get]
 Arbitrary email addresses to send notifications to when this job is complete. More...
 
string JobNotificationNote [get, set]
 A note to append to the notification email sent out when the job is complete. More...
 
string [] JobNotificationTargets [get]
 The list of users that are to be notified when this job is complete. More...
 
string JobOnJobComplete [get, set]
 What the job should do when it completes. The options are "Archive", "Delete", or "Nothing". More...
 
string JobOnTaskTimeout [get, set]
 What to do when a task times out. The options are "Error", "Notify", or "Both". More...
 
string [] JobOutputDirectories [get]
 The list of output directories. More...
 
string [] JobOutputFileNames [get]
 The list of output filenames. More...
 
string [][] JobOutputTileFileNames [get]
 The list of output filenames for tile jobs. More...
 
bool JobOverrideAutoJobCleanup [get, set]
 If the job overrides the automatic job cleanup in the Repository Options. More...
 
bool JobOverrideJobCleanup [get, set]
 If the job overrides the amount of days before its cleaned up. More...
 
int JobOverrideJobCleanupDays [get, set]
 The number of days before this job will be cleaned up after it is completed. Only relevant if the override is set. More...
 
AutoJobCleanupType JobOverrideJobCleanupType [get, set]
 The job cleanup mode. Only relevant if the override is set. More...
 
bool JobOverrideJobFailureDetection [get, set]
 Whether or not this job overrides the Job Failure Detection settings in the Repository Options. More...
 
bool JobOverrideNotificationMethod [get, set]
 If the user's notification method should be ignored. More...
 
bool JobOverrideTaskExtraInfoNames [get, set]
 Whether this job overrides the task extra info names More...
 
bool JobOverrideTaskFailureDetection [get, set]
 Whether or not this job overrides the Task Failure Detection settings in the Repository Options. More...
 
int JobPendingTasks [get]
 The number of tasks in the pending state. More...
 
string JobPlugin [get]
 The name of the Deadline plugin the job uses. More...
 
string JobPool [get, set]
 The job's pool. More...
 
bool JobPopupNotification [get, set]
 If overriding the user's notification method, whether to use send a popup notification. More...
 
string JobPostJobScript [get]
 The script to execute after the Job finishes. Read Only. Use RepositoryUtils.SetPostJobScript and RepositoryUtils.DeletePostJobScript. More...
 
string JobPostTaskScript [get, set]
 The script to execute when a job task is complete. More...
 
string JobPreJobScript [get]
 The script to execute before the job starts. Read Only. Use RepositoryUtils.SetPreJobScript and RepositoryUtils.DeletePreJobScript. More...
 
string JobPreTaskScript [get, set]
 The script to execute before a job task starts. More...
 
int JobPriority [get, set]
 The job's priority (0 is the lowest). More...
 
bool JobProtected [get, set]
 If set to True, the job can only be deleted or archived by the job's user, or by someone who has permissions to handle protected jobs. More...
 
int JobQueuedTasks [get]
 The number of tasks in the queued state. More...
 
int JobRenderingTasks [get]
 The number of tasks in the active state. More...
 
AssetDependency [] JobRequiredAssets [get]
 The assets that are required in order to render this job. The assets should contain absolute paths. More...
 
bool JobResumeOnCompleteDependencies [get, set]
 If the job should resume on complete dependencies. More...
 
bool JobResumeOnDeletedDependencies [get, set]
 If the job should resume on deleted dependencies. More...
 
bool JobResumeOnFailedDependencies [get, set]
 If the job should resume on failed dependencies. More...
 
TimeSpan JobSaturdayStartTime [get, set]
 Gets or sets Saturday's start time. More...
 
TimeSpan JobSaturdayStopTime [get, set]
 Gets or sets Saturday's stop time. More...
 
int JobScheduledDays [get, set]
 The day interval for daily scheduled jobs. More...
 
DateTime JobScheduledStartDateTime [get, set]
 The start date/time at which the scheduled job should start. More...
 
DateTime JobScheduledStopDateTime [get, set]
 The stop date/time at which the job should stop if it's still active. More...
 
string JobScheduledType [get, set]
 The scheduling mode for this job. The options are "None", "Once", "Daily". or "Custom". More...
 
ScriptDependency [] JobScriptDependencies [get]
 The scripts that must return True in order to render this job. More...
 
string JobSecondaryPool [get, set]
 The Secondary Pool in which this Job belongs. More...
 
bool JobSendJobErrorWarning [get, set]
 If the job should send warning notifications when it reaches a certain number of errors. More...
 
bool JobSequentialJob [get, set]
 If the job is a sequential job, which ensures its tasks only render in ascending order. More...
 
DateTime JobStartedDateTime [get]
 The date/time at which the job started rendering. More...
 
int JobStartJobTimeoutSeconds [get, set]
 The timespan a job's task has to start before a timeout occurs. More...
 
string JobStatus [get]
 The job's current state. More...
 
DateTime JobSubmitDateTime [get]
 The date/time at which the job was submitted. More...
 
string JobSubmitMachine [get]
 This is the machine that the job was submitted from. More...
 
TimeSpan JobSundayStartTime [get, set]
 Gets or sets Sunday's start time. More...
 
TimeSpan JobSundayStopTime [get, set]
 Gets or sets Sunday's stop time. More...
 
bool JobSuppressEvents [get, set]
 Whether or not this Job should suppress Events plugins. More...
 
int JobSuspendedTasks [get]
 The number of tasks in the suspended state. More...
 
bool JobSynchronizeAllAuxiliaryFiles [get, set]
 If the job's auxiliary files should be synced up by the slave between tasks. More...
 
int JobTaskCount [get]
 The number of tasks the job has. More...
 
string JobTaskExtraInfoName0 [get, set]
 One of the Task's ten Extra Info names More...
 
string JobTaskExtraInfoName1 [get, set]
 One of the Task's ten Extra Info names More...
 
string JobTaskExtraInfoName2 [get, set]
 One of the Task's ten Extra Info names More...
 
string JobTaskExtraInfoName3 [get, set]
 One of the Task's ten Extra Info names More...
 
string JobTaskExtraInfoName4 [get, set]
 One of the Task's ten Extra Info names More...
 
string JobTaskExtraInfoName5 [get, set]
 One of the Task's ten Extra Info names More...
 
string JobTaskExtraInfoName6 [get, set]
 One of the Task's ten Extra Info names More...
 
string JobTaskExtraInfoName7 [get, set]
 One of the Task's ten Extra Info names More...
 
string JobTaskExtraInfoName8 [get, set]
 One of the Task's ten Extra Info names More...
 
string JobTaskExtraInfoName9 [get, set]
 One of the Task's ten Extra Info names More...
 
int JobTaskTimeoutSeconds [get, set]
 The timespan a job's task has to render before a timeout occurs. More...
 
TimeSpan JobThursdayStartTime [get, set]
 Gets or sets Thursday's start time. More...
 
TimeSpan JobThursdayStopTime [get, set]
 Gets or sets Thursday's stop time. More...
 
bool JobTileJob [get]
 If this job is a tile job. More...
 
int JobTileJobFrame [get]
 The frame that the tile job is rendering. More...
 
int JobTileJobTileCount [get]
 The number of tiles in a tile job. More...
 
int JobTileJobTilesInX [get]
 The number of tiles in X for a tile job. This is deprecated, and is only here for backwards compatibility. More...
 
int JobTileJobTilesInY [get]
 The number of tiles in Y for a tile job. This is deprecated, and is only here for backwards compatibility. More...
 
TimeSpan JobTuesdayStartTime [get, set]
 Gets or sets Tuesday's start time. More...
 
TimeSpan JobTuesdayStopTime [get, set]
 Gets or sets Tuesday's stop time. More...
 
bool JobUseJobEnvironmentOnly [get, set]
 If only the job's environment variables should be used. If disabled, the job's environment will be merged with the current environment. More...
 
string JobUserName [get, set]
 The user that submitted the job. More...
 
TimeSpan JobWednesdayStartTime [get, set]
 Gets or sets Wednesday's start time. More...
 
TimeSpan JobWednesdayStopTime [get, set]
 Gets or sets Wednesday's stop time. More...
 
bool JobWhitelistFlag [get]
 If the job's listed slaves are a whitelist or a blacklist. More...
 
int RemTimeThreshold [get, set]
 The remaining time (in seconds) that this Job must have left more than in order to be interruptible More...
 

Detailed Description

A job.

Member Function Documentation

◆ DeleteJobEnvironmentKey()

void Deadline.Jobs.Job.DeleteJobEnvironmentKey ( string  key)

Deletes the environment variable for the given key.

Parameters
keyThe key.

◆ DeleteJobExtraInfoKey()

void Deadline.Jobs.Job.DeleteJobExtraInfoKey ( string  key)

Deletes the extra info for the given key.

Parameters
keyThe key.

◆ GetJobEnvironmentKeys()

string [] Deadline.Jobs.Job.GetJobEnvironmentKeys ( )

Gets the keys for the job's environment variable entries.

Returns
The keys, as a list of strings.

◆ GetJobEnvironmentKeyValue()

string Deadline.Jobs.Job.GetJobEnvironmentKeyValue ( string  key)

Gets the environment variable value for the given key.

Parameters
keyThe key.
Returns
The value, as a string. If the key isn't found, an empty string is returned.

◆ GetJobExtraInfoKeys()

string [] Deadline.Jobs.Job.GetJobExtraInfoKeys ( )

Gets the keys for the job's extra info entries.

Returns
The keys, as a list of strings.

◆ GetJobExtraInfoKeyValue()

string Deadline.Jobs.Job.GetJobExtraInfoKeyValue ( string  key)

Gets the extra info value for the given key.

Parameters
keyThe key.
Returns
The value, as a string. If the key isn't found, an empty string is returned.

◆ GetJobExtraInfoKeyValueWithDefault()

string Deadline.Jobs.Job.GetJobExtraInfoKeyValueWithDefault ( string  key,
string  defaultValue 
)

Gets the extra info value for the given key.

Parameters
keyThe key.
defaultValueThe default value
Returns
The value, as a string. If the key isn't found, an empty string is returned.

◆ GetJobInfoKeys()

string [] Deadline.Jobs.Job.GetJobInfoKeys ( )

Gets the job info keys.

Returns

◆ GetJobInfoKeyValue()

string Deadline.Jobs.Job.GetJobInfoKeyValue ( string  key)

Get the job infor value for the provided key.

Parameters
key
Returns

◆ GetJobPluginInfoKeys()

string [] Deadline.Jobs.Job.GetJobPluginInfoKeys ( )

Gets the keys for the job's plugin info entries.

Returns
The keys, as a list of strings.

◆ GetJobPluginInfoKeyValue()

string Deadline.Jobs.Job.GetJobPluginInfoKeyValue ( string  key)

Gets the plugin info value for the given key.

Parameters
keyThe key.
Returns
The value, as a string. If the key isn't found, an empty string is returned.

◆ SetJobDependencyIDs()

void Deadline.Jobs.Job.SetJobDependencyIDs ( object  jobIds)

Sets the IDs of the jobs that this job is dependent on.

Parameters
jobIdsThe job IDs. This should be a list of strings.

◆ SetJobEnvironmentKeyValue()

void Deadline.Jobs.Job.SetJobEnvironmentKeyValue ( string  key,
string  value 
)

Sets the environment variable value for the given key.

Parameters
keyThe key.
valueThe value.

◆ SetJobExtraInfoKeyValue()

void Deadline.Jobs.Job.SetJobExtraInfoKeyValue ( string  key,
string  value 
)

Sets the extra info value for the given key.

Parameters
keyThe key.
valueThe value.

◆ SetJobLimitGroups()

void Deadline.Jobs.Job.SetJobLimitGroups ( object  limitGroups)

Sets the limit groups the job requires.

Parameters
limitGroupsThe limit group names. This should be a list of strings.

◆ SetJobNotificationEmails()

void Deadline.Jobs.Job.SetJobNotificationEmails ( object  emails)

Sets the arbitrary email addresses to send notifications to when this job is complete.

Parameters
emailsThe email addresses. This should be a list of strings.

◆ SetJobNotificationTargets()

void Deadline.Jobs.Job.SetJobNotificationTargets ( object  userNames)

Sets the list of users that are to be notified when this job is complete.

Parameters
userNamesThe user names. This should be a list of strings.

◆ SetJobPluginInfoKeyValue()

void Deadline.Jobs.Job.SetJobPluginInfoKeyValue ( string  key,
string  value 
)

Sets the plugin info value for the given key.

Parameters
keyThe key.
valueThe value.

◆ SetJobRequiredAssets()

void Deadline.Jobs.Job.SetJobRequiredAssets ( object  assets)

Sets the assets that are required in order to render this job. The assets should contain absolute paths.

Parameters
assetsThe asset paths. These should be absolute paths. This should be a list of strings.

◆ SetScriptDependencies()

void Deadline.Jobs.Job.SetScriptDependencies ( object  scripts)

Sets the scripts that must return True in order to render this job.

Parameters
scriptsThe script paths. This should be a list of strings.

Member Data Documentation

◆ DisabledScheduleTime

TimeSpan Deadline.Jobs.Job.DisabledScheduleTime = TimeSpan.MinValue
static

Represents a disabled scheduled time for custom job scheduling settings.

Property Documentation

◆ JobAuxiliarySubmissionFileNames

string [] Deadline.Jobs.Job.JobAuxiliarySubmissionFileNames
get

The auxiliary files submitted with the job.

◆ JobBatchName

string Deadline.Jobs.Job.JobBatchName
getset

The name of the Batch that this job belongs to.

◆ JobComment

string Deadline.Jobs.Job.JobComment
getset

A brief comment about the job.

◆ JobCompletedDateTime

DateTime Deadline.Jobs.Job.JobCompletedDateTime
get

The date/time at which the job finished rendering.

◆ JobCompletedTasks

int Deadline.Jobs.Job.JobCompletedTasks
get

The number of tasks in the completed state.

◆ JobConcurrentTasks

int Deadline.Jobs.Job.JobConcurrentTasks
getset

The maximum number of concurrent tasks a slave can dequeue for this job at a time. The value must be between 1 and 16 inclusive.

◆ JobCustomEventPluginDirectory

string Deadline.Jobs.Job.JobCustomEventPluginDirectory
getset

A custom location to load the job's event plugin from.

◆ JobCustomPluginDirectory

string Deadline.Jobs.Job.JobCustomPluginDirectory
getset

A custom location to load the job's plugin from.

◆ JobDepartment

string Deadline.Jobs.Job.JobDepartment
getset

The department to which the job's user belongs to.

◆ JobDependencyIDs

string [] Deadline.Jobs.Job.JobDependencyIDs
get

The ids of the jobs that this job is dependent on.

◆ JobDependencyPercentageValue

float Deadline.Jobs.Job.JobDependencyPercentageValue
getset

This job will resume when its dependencies have completed this percentage of their tasks.

◆ JobEmailNotification

bool Deadline.Jobs.Job.JobEmailNotification
getset

If overriding the user's notification method, whether to use email notification.

◆ JobEnableAutoTimeout

bool Deadline.Jobs.Job.JobEnableAutoTimeout
getset

The Auto Task Timeout feature is based on the Auto Job Timeout Settings in the Repository Options. The timeout is based on the render times of the tasks that have already finished for this job, so this option should only be used if the frames for the job have consistent render times.

◆ JobEnableFrameTimeouts

bool Deadline.Jobs.Job.JobEnableFrameTimeouts
getset

If the timeouts are Frame based instead of Task based.

◆ JobEnableTimeoutsForScriptTasks

bool Deadline.Jobs.Job.JobEnableTimeoutsForScriptTasks
getset

If the timeouts should apply to pre/post job script tasks.

◆ JobExtraInfo0

string Deadline.Jobs.Job.JobExtraInfo0
getset

One of the Job's ten Extra Info fields

◆ JobExtraInfo1

string Deadline.Jobs.Job.JobExtraInfo1
getset

One of the Job's ten Extra Info fields

◆ JobExtraInfo2

string Deadline.Jobs.Job.JobExtraInfo2
getset

One of the Job's ten Extra Info fields

◆ JobExtraInfo3

string Deadline.Jobs.Job.JobExtraInfo3
getset

One of the Job's ten Extra Info fields

◆ JobExtraInfo4

string Deadline.Jobs.Job.JobExtraInfo4
getset

One of the Job's ten Extra Info fields

◆ JobExtraInfo5

string Deadline.Jobs.Job.JobExtraInfo5
getset

One of the Job's ten Extra Info fields

◆ JobExtraInfo6

string Deadline.Jobs.Job.JobExtraInfo6
getset

One of the Job's ten Extra Info fields

◆ JobExtraInfo7

string Deadline.Jobs.Job.JobExtraInfo7
getset

One of the Job's ten Extra Info fields

◆ JobExtraInfo8

string Deadline.Jobs.Job.JobExtraInfo8
getset

One of the Job's ten Extra Info fields

◆ JobExtraInfo9

string Deadline.Jobs.Job.JobExtraInfo9
getset

One of the Job's ten Extra Info fields

◆ JobFailedTasks

int Deadline.Jobs.Job.JobFailedTasks
get

The number of tasks in the failed state.

◆ JobFailureDetectionJobErrors

int Deadline.Jobs.Job.JobFailureDetectionJobErrors
getset

If JobOverrideJobFailureDetection is enabled, this is the number of errors it takes to trigger a job failure.

◆ JobFailureDetectionTaskErrors

int Deadline.Jobs.Job.JobFailureDetectionTaskErrors
getset

If JobOverrideTaskFailureDetection is enabled, this is the number of errors it takes to trigger a task failure.

◆ JobForceReloadPlugin

bool Deadline.Jobs.Job.JobForceReloadPlugin
getset

Whether or not the job's plugin should be reloaded between tasks.

◆ JobFrameDependencyOffsetEnd

int Deadline.Jobs.Job.JobFrameDependencyOffsetEnd
getset

The end offset for frame depenencies.

◆ JobFrameDependencyOffsetStart

int Deadline.Jobs.Job.JobFrameDependencyOffsetStart
getset

The start offset for frame depenencies.

◆ JobFrames

string Deadline.Jobs.Job.JobFrames
get

The job's frame list as a string.

◆ JobFramesList

int [] Deadline.Jobs.Job.JobFramesList
get

The job's frame list as an array.

◆ JobFramesPerTask

int Deadline.Jobs.Job.JobFramesPerTask
get

The number of frames per task.

◆ JobFridayStartTime

TimeSpan Deadline.Jobs.Job.JobFridayStartTime
getset

Gets or sets Friday's start time.

◆ JobFridayStopTime

TimeSpan Deadline.Jobs.Job.JobFridayStopTime
getset

Gets or sets Friday's stop time.

◆ JobGroup

string Deadline.Jobs.Job.JobGroup
getset

The job's group.

◆ JobId

string Deadline.Jobs.Job.JobId
get

The job's ID.

◆ JobIgnoreBadSlaveDetection

bool Deadline.Jobs.Job.JobIgnoreBadSlaveDetection
getset

Whether or not this job overrides the Bad Slave Detection settings in the Repository Options.

◆ JobInitializePluginTimeoutSeconds

int Deadline.Jobs.Job.JobInitializePluginTimeoutSeconds
getset

The timespan a job's task has to start before a timeout occurs.

◆ JobInterruptible

bool Deadline.Jobs.Job.JobInterruptible
getset

If the job is interruptible, which causes it to be canceled when a job with higher priority comes along.

◆ JobInterruptiblePercentage

int Deadline.Jobs.Job.JobInterruptiblePercentage
getset

The completion percentage that this Job must be less than in order to be interruptible

◆ JobIsFrameDependent

bool Deadline.Jobs.Job.JobIsFrameDependent
getset

If the job is frame dependent.

◆ JobLimitGroups

string [] Deadline.Jobs.Job.JobLimitGroups
get

The limit groups the job requires.

◆ JobLimitTasksToNumberOfCpus

bool Deadline.Jobs.Job.JobLimitTasksToNumberOfCpus
getset

Whether or not the number of concurrent tasks a slave can dequeue for this job should be limited to the number of CPUs the slave has.

◆ JobListedSlaves

string [] Deadline.Jobs.Job.JobListedSlaves
get

The list of black/white listed slaves for the job. Use JobWhitelistFlag to determine if the list is a blacklist or a whitelist.

◆ JobMachineLimit

int Deadline.Jobs.Job.JobMachineLimit
get

The machine limit for the job.

◆ JobMachineLimitProgress

double Deadline.Jobs.Job.JobMachineLimitProgress
get

When the slave reaches this progress for the job's task, it will release the limit group.

◆ JobMaintenanceJob

bool Deadline.Jobs.Job.JobMaintenanceJob
get

If this is a maintenance job.

◆ JobMaintenanceJobEndFrame

int Deadline.Jobs.Job.JobMaintenanceJobEndFrame
get

The start frame for a maintenance job.

◆ JobMaintenanceJobStartFrame

int Deadline.Jobs.Job.JobMaintenanceJobStartFrame
get

The start frame for a maintenance job.

◆ JobMinRenderTimeSeconds

int Deadline.Jobs.Job.JobMinRenderTimeSeconds
getset

The minimum number of seconds a job must run to be considered successful.

◆ JobMondayStartTime

TimeSpan Deadline.Jobs.Job.JobMondayStartTime
getset

Gets or sets Monday's start time.

◆ JobMondayStopTime

TimeSpan Deadline.Jobs.Job.JobMondayStopTime
getset

Gets or sets Monday's stop time.

◆ JobName

string Deadline.Jobs.Job.JobName
getset

The job's name.

◆ JobNotificationEmails

string [] Deadline.Jobs.Job.JobNotificationEmails
get

Arbitrary email addresses to send notifications to when this job is complete.

◆ JobNotificationNote

string Deadline.Jobs.Job.JobNotificationNote
getset

A note to append to the notification email sent out when the job is complete.

◆ JobNotificationTargets

string [] Deadline.Jobs.Job.JobNotificationTargets
get

The list of users that are to be notified when this job is complete.

◆ JobOnJobComplete

string Deadline.Jobs.Job.JobOnJobComplete
getset

What the job should do when it completes. The options are "Archive", "Delete", or "Nothing".

◆ JobOnTaskTimeout

string Deadline.Jobs.Job.JobOnTaskTimeout
getset

What to do when a task times out. The options are "Error", "Notify", or "Both".

◆ JobOutputDirectories

string [] Deadline.Jobs.Job.JobOutputDirectories
get

The list of output directories.

◆ JobOutputFileNames

string [] Deadline.Jobs.Job.JobOutputFileNames
get

The list of output filenames.

◆ JobOutputTileFileNames

string [][] Deadline.Jobs.Job.JobOutputTileFileNames
get

The list of output filenames for tile jobs.

◆ JobOverrideAutoJobCleanup

bool Deadline.Jobs.Job.JobOverrideAutoJobCleanup
getset

If the job overrides the automatic job cleanup in the Repository Options.

◆ JobOverrideJobCleanup

bool Deadline.Jobs.Job.JobOverrideJobCleanup
getset

If the job overrides the amount of days before its cleaned up.

◆ JobOverrideJobCleanupDays

int Deadline.Jobs.Job.JobOverrideJobCleanupDays
getset

The number of days before this job will be cleaned up after it is completed. Only relevant if the override is set.

◆ JobOverrideJobCleanupType

AutoJobCleanupType Deadline.Jobs.Job.JobOverrideJobCleanupType
getset

The job cleanup mode. Only relevant if the override is set.

◆ JobOverrideJobFailureDetection

bool Deadline.Jobs.Job.JobOverrideJobFailureDetection
getset

Whether or not this job overrides the Job Failure Detection settings in the Repository Options.

◆ JobOverrideNotificationMethod

bool Deadline.Jobs.Job.JobOverrideNotificationMethod
getset

If the user's notification method should be ignored.

◆ JobOverrideTaskExtraInfoNames

bool Deadline.Jobs.Job.JobOverrideTaskExtraInfoNames
getset

Whether this job overrides the task extra info names

◆ JobOverrideTaskFailureDetection

bool Deadline.Jobs.Job.JobOverrideTaskFailureDetection
getset

Whether or not this job overrides the Task Failure Detection settings in the Repository Options.

◆ JobPendingTasks

int Deadline.Jobs.Job.JobPendingTasks
get

The number of tasks in the pending state.

◆ JobPlugin

string Deadline.Jobs.Job.JobPlugin
get

The name of the Deadline plugin the job uses.

◆ JobPool

string Deadline.Jobs.Job.JobPool
getset

The job's pool.

◆ JobPopupNotification

bool Deadline.Jobs.Job.JobPopupNotification
getset

If overriding the user's notification method, whether to use send a popup notification.

◆ JobPostJobScript

string Deadline.Jobs.Job.JobPostJobScript
get

The script to execute after the Job finishes. Read Only. Use RepositoryUtils.SetPostJobScript and RepositoryUtils.DeletePostJobScript.

◆ JobPostTaskScript

string Deadline.Jobs.Job.JobPostTaskScript
getset

The script to execute when a job task is complete.

◆ JobPreJobScript

string Deadline.Jobs.Job.JobPreJobScript
get

The script to execute before the job starts. Read Only. Use RepositoryUtils.SetPreJobScript and RepositoryUtils.DeletePreJobScript.

◆ JobPreTaskScript

string Deadline.Jobs.Job.JobPreTaskScript
getset

The script to execute before a job task starts.

◆ JobPriority

int Deadline.Jobs.Job.JobPriority
getset

The job's priority (0 is the lowest).

◆ JobProtected

bool Deadline.Jobs.Job.JobProtected
getset

If set to True, the job can only be deleted or archived by the job's user, or by someone who has permissions to handle protected jobs.

◆ JobQueuedTasks

int Deadline.Jobs.Job.JobQueuedTasks
get

The number of tasks in the queued state.

◆ JobRenderingTasks

int Deadline.Jobs.Job.JobRenderingTasks
get

The number of tasks in the active state.

◆ JobRequiredAssets

AssetDependency [] Deadline.Jobs.Job.JobRequiredAssets
get

The assets that are required in order to render this job. The assets should contain absolute paths.

◆ JobResumeOnCompleteDependencies

bool Deadline.Jobs.Job.JobResumeOnCompleteDependencies
getset

If the job should resume on complete dependencies.

◆ JobResumeOnDeletedDependencies

bool Deadline.Jobs.Job.JobResumeOnDeletedDependencies
getset

If the job should resume on deleted dependencies.

◆ JobResumeOnFailedDependencies

bool Deadline.Jobs.Job.JobResumeOnFailedDependencies
getset

If the job should resume on failed dependencies.

◆ JobSaturdayStartTime

TimeSpan Deadline.Jobs.Job.JobSaturdayStartTime
getset

Gets or sets Saturday's start time.

◆ JobSaturdayStopTime

TimeSpan Deadline.Jobs.Job.JobSaturdayStopTime
getset

Gets or sets Saturday's stop time.

◆ JobScheduledDays

int Deadline.Jobs.Job.JobScheduledDays
getset

The day interval for daily scheduled jobs.

◆ JobScheduledStartDateTime

DateTime Deadline.Jobs.Job.JobScheduledStartDateTime
getset

The start date/time at which the scheduled job should start.

◆ JobScheduledStopDateTime

DateTime Deadline.Jobs.Job.JobScheduledStopDateTime
getset

The stop date/time at which the job should stop if it's still active.

◆ JobScheduledType

string Deadline.Jobs.Job.JobScheduledType
getset

The scheduling mode for this job. The options are "None", "Once", "Daily". or "Custom".

◆ JobScriptDependencies

ScriptDependency [] Deadline.Jobs.Job.JobScriptDependencies
get

The scripts that must return True in order to render this job.

◆ JobSecondaryPool

string Deadline.Jobs.Job.JobSecondaryPool
getset

The Secondary Pool in which this Job belongs.

◆ JobSendJobErrorWarning

bool Deadline.Jobs.Job.JobSendJobErrorWarning
getset

If the job should send warning notifications when it reaches a certain number of errors.

◆ JobSequentialJob

bool Deadline.Jobs.Job.JobSequentialJob
getset

If the job is a sequential job, which ensures its tasks only render in ascending order.

◆ JobStartedDateTime

DateTime Deadline.Jobs.Job.JobStartedDateTime
get

The date/time at which the job started rendering.

◆ JobStartJobTimeoutSeconds

int Deadline.Jobs.Job.JobStartJobTimeoutSeconds
getset

The timespan a job's task has to start before a timeout occurs.

◆ JobStatus

string Deadline.Jobs.Job.JobStatus
get

The job's current state.

◆ JobSubmitDateTime

DateTime Deadline.Jobs.Job.JobSubmitDateTime
get

The date/time at which the job was submitted.

◆ JobSubmitMachine

string Deadline.Jobs.Job.JobSubmitMachine
get

This is the machine that the job was submitted from.

◆ JobSundayStartTime

TimeSpan Deadline.Jobs.Job.JobSundayStartTime
getset

Gets or sets Sunday's start time.

◆ JobSundayStopTime

TimeSpan Deadline.Jobs.Job.JobSundayStopTime
getset

Gets or sets Sunday's stop time.

◆ JobSuppressEvents

bool Deadline.Jobs.Job.JobSuppressEvents
getset

Whether or not this Job should suppress Events plugins.

◆ JobSuspendedTasks

int Deadline.Jobs.Job.JobSuspendedTasks
get

The number of tasks in the suspended state.

◆ JobSynchronizeAllAuxiliaryFiles

bool Deadline.Jobs.Job.JobSynchronizeAllAuxiliaryFiles
getset

If the job's auxiliary files should be synced up by the slave between tasks.

◆ JobTaskCount

int Deadline.Jobs.Job.JobTaskCount
get

The number of tasks the job has.

◆ JobTaskExtraInfoName0

string Deadline.Jobs.Job.JobTaskExtraInfoName0
getset

One of the Task's ten Extra Info names

◆ JobTaskExtraInfoName1

string Deadline.Jobs.Job.JobTaskExtraInfoName1
getset

One of the Task's ten Extra Info names

◆ JobTaskExtraInfoName2

string Deadline.Jobs.Job.JobTaskExtraInfoName2
getset

One of the Task's ten Extra Info names

◆ JobTaskExtraInfoName3

string Deadline.Jobs.Job.JobTaskExtraInfoName3
getset

One of the Task's ten Extra Info names

◆ JobTaskExtraInfoName4

string Deadline.Jobs.Job.JobTaskExtraInfoName4
getset

One of the Task's ten Extra Info names

◆ JobTaskExtraInfoName5

string Deadline.Jobs.Job.JobTaskExtraInfoName5
getset

One of the Task's ten Extra Info names

◆ JobTaskExtraInfoName6

string Deadline.Jobs.Job.JobTaskExtraInfoName6
getset

One of the Task's ten Extra Info names

◆ JobTaskExtraInfoName7

string Deadline.Jobs.Job.JobTaskExtraInfoName7
getset

One of the Task's ten Extra Info names

◆ JobTaskExtraInfoName8

string Deadline.Jobs.Job.JobTaskExtraInfoName8
getset

One of the Task's ten Extra Info names

◆ JobTaskExtraInfoName9

string Deadline.Jobs.Job.JobTaskExtraInfoName9
getset

One of the Task's ten Extra Info names

◆ JobTaskTimeoutSeconds

int Deadline.Jobs.Job.JobTaskTimeoutSeconds
getset

The timespan a job's task has to render before a timeout occurs.

◆ JobThursdayStartTime

TimeSpan Deadline.Jobs.Job.JobThursdayStartTime
getset

Gets or sets Thursday's start time.

◆ JobThursdayStopTime

TimeSpan Deadline.Jobs.Job.JobThursdayStopTime
getset

Gets or sets Thursday's stop time.

◆ JobTileJob

bool Deadline.Jobs.Job.JobTileJob
get

If this job is a tile job.

◆ JobTileJobFrame

int Deadline.Jobs.Job.JobTileJobFrame
get

The frame that the tile job is rendering.

◆ JobTileJobTileCount

int Deadline.Jobs.Job.JobTileJobTileCount
get

The number of tiles in a tile job.

◆ JobTileJobTilesInX

int Deadline.Jobs.Job.JobTileJobTilesInX
get

The number of tiles in X for a tile job. This is deprecated, and is only here for backwards compatibility.

◆ JobTileJobTilesInY

int Deadline.Jobs.Job.JobTileJobTilesInY
get

The number of tiles in Y for a tile job. This is deprecated, and is only here for backwards compatibility.

◆ JobTuesdayStartTime

TimeSpan Deadline.Jobs.Job.JobTuesdayStartTime
getset

Gets or sets Tuesday's start time.

◆ JobTuesdayStopTime

TimeSpan Deadline.Jobs.Job.JobTuesdayStopTime
getset

Gets or sets Tuesday's stop time.

◆ JobUseJobEnvironmentOnly

bool Deadline.Jobs.Job.JobUseJobEnvironmentOnly
getset

If only the job's environment variables should be used. If disabled, the job's environment will be merged with the current environment.

◆ JobUserName

string Deadline.Jobs.Job.JobUserName
getset

The user that submitted the job.

◆ JobWednesdayStartTime

TimeSpan Deadline.Jobs.Job.JobWednesdayStartTime
getset

Gets or sets Wednesday's start time.

◆ JobWednesdayStopTime

TimeSpan Deadline.Jobs.Job.JobWednesdayStopTime
getset

Gets or sets Wednesday's stop time.

◆ JobWhitelistFlag

bool Deadline.Jobs.Job.JobWhitelistFlag
get

If the job's listed slaves are a whitelist or a blacklist.

◆ RemTimeThreshold

int Deadline.Jobs.Job.RemTimeThreshold
getset

The remaining time (in seconds) that this Job must have left more than in order to be interruptible