Classes
class	AssetDependency
	The AssetDependency Class More...

class	BaseDependency
	BaseDependency class. More...

class	Job
	A job. More...

class	JobDependency
	Job Dependency class. More...

class	OffsetDependency
	OffsetDependency class More...

class	ScriptDependency
	ScriptDependency class. More...

class	Task
	A task. More...

class	TaskCollection
	A collection of tasks. More...

class	TaskProperties
	Task properties class. More...

Enumerations
enum class	AutoJobCleanupType { DeleteJobs , ArchiveJobs }
	What to do during auto job cleanup. More...

enum class	JobCompleteAction { Archive , Delete , Nothing }
	What a job should do when it is complete. More...

enum class	JobScheduledType { None = 0 , NotScheduled = None , Once = 1 , Daily = 2 , Custom = 3 }
	The job's scheduled type. More...

enum class	JobStatus { Unknown = 0 , Active = 1 , Suspended = 2 , Completed = 3 , Failed = 4 , Pending = 6 }
	The states a job can be in. More...

enum class	TaskOnTimeout { ErrorAndNotify , Error , Notify , Complete , RequeueAndNotify , Requeue , FailAndNotify , Fail }
	What to do when a task times out. More...

enum class	TaskStatus { Unknown = 1 , Queued = 2 , Suspended = 3 , Rendering = 4 , Completed = 5 , Failed = 6 , Pending = 8 }
	The states a task can be in. More...

Enumeration Type Documentation

◆ AutoJobCleanupType

strong

What to do during auto job cleanup.

Enumerator
DeleteJobs	Delete all unarchived completed jobs.
ArchiveJobs	Archive all unarchived completed jobs.

strong

What a job should do when it is complete.

Enumerator
Archive	The job should be archived when it completes.
Delete	The job should be deleted when it completes.
Nothing	Nothing should be done when the job is complete.

strong

The job's scheduled type.

Enumerator
None	The job is not scheduled.
NotScheduled	The Job is not scheduled. Synonym for the 'None' type for Python compatibility purposes.
Once	The job is scheduled to run once.
Daily	The job is scheduled to run on daily intervals.
Custom	The job follows a custom schedule.

strong

The states a job can be in.

Enumerator
Unknown	The job state is unknown.
Active	The job is active (queued or rendering).
Suspended	The job is suspended.
Completed	The job is completed.
Failed	The job has failed.
Pending	The job is pending.

strong

What to do when a task times out.

Enumerator
ErrorAndNotify	Report an error and notify the user.
Error	Report an error only.
Notify	Notify the user only.
Complete	Mark the task as complete.
RequeueAndNotify	Requeue the task and notify the user.
Requeue	Fail the task and report an error.
FailAndNotify	Fail the task, report an error, and notify the user.
Fail	Fail the task and report an error.

strong

The states a task can be in.