A job. More...

Inherits BaseGenericDocument, 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 Worker 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 Worker 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 Worker can dequeue for this job should be limited to the number of CPUs the Worker has. More...

string[]	JobListedSlaves `[get]`
	The list of Workers in allow or deny list for the job. Use JobWhitelistFlag to determine if the list is a deny list or an allow list. More...

int	JobMachineLimit `[get]`
	The machine limit for the job. More...

double	JobMachineLimitProgress `[get]`
	When the Worker 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 Worker 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 Workers are an allow list or a deny list. 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

key The key.

◆ DeleteJobExtraInfoKey()

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

Deletes the extra info for the given key.

Parameters

key The 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

key The 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

key The 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

key	The key.
defaultValue	The 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

key The 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

jobIds The 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

key	The key.
value	The value.

◆ SetJobExtraInfoKeyValue()

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

Sets the extra info value for the given key.

Parameters

key	The key.
value	The value.

◆ SetJobLimitGroups()

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

Sets the limit groups the job requires.

Parameters

limitGroups The 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

emails The 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

userNames The 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

key	The key.
value	The 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

assets The 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

scripts The 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 Worker 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.