package job
Get desktop application:
View/edit binary Protocol Buffers messages
service FrameInterface
job.proto:21rpc AddRenderPartition (, )
job.proto:23Add a render partition to the frame.
message
job.proto:836FRAME ---- AddRenderPartition
optional frame = 1
string host = 2
int32 threads = 3
int32 max_cores = 4
int64 max_memory = 5
int64 max_gpu_memory = 6
string username = 7
int32 max_gpus = 8
message
job.proto:847optional render_partition = 1
rpc CreateDependencyOnFrame (, )
job.proto:26Sets up and returns a FrameOnFrame dependency.
message
job.proto:852CreateDependencyOnFrame
optional frame = 1
optional depend_on_frame = 2
message
job.proto:857optional depend = 1
rpc CreateDependencyOnJob (, )
job.proto:29Sets up and returns a FrameOnJob dependency.
message
job.proto:862CreateDependencyOnJob
optional frame = 1
optional job = 2
message
job.proto:867optional depend = 1
rpc CreateDependencyOnLayer (, )
job.proto:32Sets up and returns a FrameOnLayer dependency.
message
job.proto:872CreateDependencyOnLayer
optional frame = 1
optional layer = 2
message
job.proto:877optional depend = 1
rpc DropDepends (, )
job.proto:35Drops every dependendy that is causing this frame not to run.
message
job.proto:882DropDepends
optional frame = 1
depend.DependTarget target = 2
message
job.proto:887(message has no fields)
rpc Eat (, )
job.proto:38Eating a frame will stop rendering and will not try to coninue processing the frame.
message
job.proto:890Eat
optional frame = 1
message
job.proto:894(message has no fields)
rpc FindFrame (, )
job.proto:41Finds a frame in a pending job based on the job, layer, and frame number.
message
job.proto:897FindFrame
string job = 1
string layer = 2
int32 frame = 3
message
job.proto:903optional frame = 1
rpc GetFrame (, )
job.proto:44Get a frame from its unique id
message
job.proto:908GetFrame
string id = 1
message
job.proto:912optional frame = 1
Get a frame's state display overrides
message
job.proto:1859optional frame = 1
message
job.proto:1863optional overrides = 1
rpc GetFrames (, )
job.proto:47Get a frame from search criteria
message
job.proto:917GetFrames
string job = 1
optional r = 2
message
job.proto:922optional frames = 1
rpc GetWhatDependsOnThis (, )
job.proto:50Returns a list of dependencies setup to depend on this frame.
message
job.proto:927GetWhatDependsOnThis
optional frame = 1
message
job.proto:931optional depends = 1
rpc GetWhatThisDependsOn (, )
job.proto:53Returns a list of dependencies that this frame depends on.
message
job.proto:936GetWhatThisDependsOn
optional frame = 1
message
job.proto:940optional depends = 1
rpc Kill (, )
job.proto:56Kills the frame if it is running
message
job.proto:945Kill
optional frame = 1
string username = 2
string pid = 3
string host_kill = 4
string reason = 5
message
job.proto:953(message has no fields)
rpc MarkAsDepend (, )
job.proto:60Will recount the number of active dependencies on the frame and put it back into the Depend state if that count is greater than 0.
message
job.proto:956MarkAsDepend
optional frame = 1
message
job.proto:960(message has no fields)
rpc MarkAsWaiting (, )
job.proto:64Changes the frame's dependency count to 0, which will put the frame into the waiting state. Retrying the frame will put it back into the waiting state.
message
job.proto:963MarkAsWaiting
optional frame = 1
message
job.proto:967(message has no fields)
rpc Retry (, )
job.proto:67Retries the frame by setting it as waiting
message
job.proto:970Retry
optional frame = 1
message
job.proto:974(message has no fields)
rpc SetCheckpointState (, )
job.proto:71Updates the state of the frame's checkpoint status. If the checkpoint status is complete, then the frame's checkpointCoreSeconds is updated with the amount of render time that was checkpointed.
message
job.proto:977SetCheckpointState
optional frame = 1
CheckpointState state = 2
message
job.proto:982(message has no fields)
Set a frame's state display override
message
job.proto:1852optional frame = 1
optional override = 2
message
job.proto:1857(message has no fields)
service GroupInterface
job.proto:80rpc CreateSubGroup (, )
job.proto:82Create a new sub group of the given name
message
job.proto:987GROUP ---- CreateSubGroup
optional group = 1
string name = 2
message
job.proto:992optional group = 1
rpc Delete (, )
job.proto:85Delete the provided group
message
job.proto:997Delete
optional group = 1
message
job.proto:1001(message has no fields)
rpc FindGroup (, )
job.proto:88Finds a group by show name and group
message
job.proto:1004FindGroup
string show = 1
string name = 2
message
job.proto:1009optional group = 1
rpc GetGroup (, )
job.proto:91Gets a group by its id
message
job.proto:1014GetGroup
string id = 1
message
job.proto:1018optional group = 1
rpc GetGroups (, )
job.proto:94Get child groups of the provided group
message
job.proto:1023GetGroups
optional group = 1
message
job.proto:1027optional groups = 1
rpc GetJobs (, )
job.proto:97Get Jobs of the provided group
message
job.proto:1032GetJobs
optional group = 1
message
job.proto:1036optional jobs = 1
rpc ReparentGroups (, )
job.proto:100Reparent the provided groups to the provided group
message
job.proto:1041ReparentGroups
optional group = 1
optional groups = 2
message
job.proto:1046(message has no fields)
rpc ReparentJobs (, )
job.proto:103Reparent the provided jobs to the provided group
message
job.proto:1049ReparentJobs
optional group = 1
optional jobs = 2
message
job.proto:1054(message has no fields)
rpc SetDefaultJobMaxCores (, )
job.proto:106Set the Default Job Max Core values to all in the provided group
message
job.proto:1057SetDefJobMaxCores
optional group = 1
float max_cores = 2
message
job.proto:1062(message has no fields)
rpc SetDefaultJobMaxGpus (, )
job.proto:112Set the Default Job Max Gpu values to all in the provided group
message
job.proto:1073SetDefaultJobMaxGpus
optional group = 1
int32 max_gpus = 2
message
job.proto:1078(message has no fields)
rpc SetDefaultJobMinCores (, )
job.proto:109Set the Default Job Min Core values to all in the provided group
message
job.proto:1065SetDefJobMinCores
optional group = 1
float min_cores = 2
message
job.proto:1070(message has no fields)
rpc SetDefaultJobMinGpus (, )
job.proto:115Set the Default Job Min Gpu values to all in the provided group
message
job.proto:1081SetDefaultJobMinGpus
optional group = 1
int32 min_gpus = 2
message
job.proto:1086(message has no fields)
rpc SetDefaultJobPriority (, )
job.proto:118Set the Default Job Priority values to all in the provided group
message
job.proto:1089SetDefJobPriority
optional group = 1
int32 priority = 2
message
job.proto:1094(message has no fields)
rpc SetDepartment (, )
job.proto:121Set the department associated with the provided group
message
job.proto:1097SetDept
optional group = 1
string dept = 2
message
job.proto:1102(message has no fields)
rpc SetGroup (, )
job.proto:124Set the provided groups parent group
message
job.proto:1105SetGroup
optional group = 1
optional parent_group = 2
message
job.proto:1110(message has no fields)
rpc SetMaxCores (, )
job.proto:127Set the group's Max Cores value
message
job.proto:1113SetMaxCores
optional group = 1
float max_cores = 2
message
job.proto:1118(message has no fields)
rpc SetMaxGpus (, )
job.proto:133Set the group's Max Gpu value
message
job.proto:1129SetMaxGpus
optional group = 1
int32 max_gpus = 2
message
job.proto:1134(message has no fields)
rpc SetMinCores (, )
job.proto:130Set the groups Min Cores values
message
job.proto:1121SetMinCores
optional group = 1
float min_cores = 2
message
job.proto:1126(message has no fields)
rpc SetMinGpus (, )
job.proto:136Set the groups Min Gpu values
message
job.proto:1137SetMinGpus
optional group = 1
int32 min_gpus = 2
message
job.proto:1142(message has no fields)
rpc SetName (, )
job.proto:139Set the groups name
message
job.proto:1145SetName
optional group = 1
string name = 2
message
job.proto:1150(message has no fields)
service JobInterface
job.proto:142rpc AddComment (, )
job.proto:144Add a comment on this job
message
job.proto:1154JOB ---- AddComment
optional job = 1
optional new_comment = 2
message
job.proto:1159(message has no fields)
rpc AddRenderPartition (, )
job.proto:148Add a render partition to the local host. This partition will run frames on the specified job.
message
job.proto:1162AddRenderPartition
optional job = 1
string host = 2
int32 threads = 3
int32 max_cores = 4
int64 max_memory = 5
int64 max_gpu_memory = 6
string username = 7
int32 max_gpus = 8
message
job.proto:1173optional render_partition = 1
rpc AddSubscriber (, )
job.proto:152Adds a subscriber to a job. When the job is finished, subscriber receives email with notification
message
job.proto:1178AddSubscriber
optional job = 1
string subscriber = 2
message
job.proto:1183(message has no fields)
rpc CreateDependencyOnFrame (, )
job.proto:155Setup and retunrn a JobOnFrame dependency
message
job.proto:1186CreateDependencyOnFrame
optional job = 1
optional frame = 2
message
job.proto:1191optional depend = 1
rpc CreateDependencyOnJob (, )
job.proto:158Setup and return a JobOnJob dependency
message
job.proto:1196CreateDependencyOnJob
optional job = 1
optional on_job = 2
message
job.proto:1201optional depend = 1
rpc CreateDependencyOnLayer (, )
job.proto:161Setup and retunrn a JobOnLayer dependency
message
job.proto:1206CreateDependencyOnLayer
optional job = 1
optional layer = 2
message
job.proto:1211optional depend = 1
rpc DropDepends (, )
job.proto:166Drops all external dependencies for the job. This means that the internal depend structure will be maintained, but everything that depends on another job will be dropped.
message
job.proto:1216DropDepends
optional job = 1
depend.DependTarget target = 2
message
job.proto:1221(message has no fields)
rpc EatFrames (, )
job.proto:169Eats all frames that match the FrameSearchCriteria
message
job.proto:1224EatFrames
optional job = 1
optional req = 2
message
job.proto:1229(message has no fields)
rpc FindJob (, )
job.proto:172Finds a pending job using the job name
message
job.proto:1232FindJob
string name = 1
message
job.proto:1236optional job = 1
rpc GetComments (, )
job.proto:175Get the comments for this job
message
job.proto:1241GetComments
optional job = 1
message
job.proto:1245optional comments = 1
rpc GetCurrent (, )
job.proto:178Get the job details
message
job.proto:1250GetCurrent
optional job = 1
message
job.proto:1254optional job = 1
rpc GetDepends (, )
job.proto:181Returns a list of all dependencies that this job is involved with
message
job.proto:1259GetDepends
optional job = 1
message
job.proto:1263optional depends = 1
rpc GetFrames (, )
job.proto:184Returns all frame objects that match FrameSearchCriteria
message
job.proto:1268GetFrames
optional job = 1
optional req = 2
message
job.proto:1273optional frames = 1
rpc GetJob (, )
job.proto:187Finds a pending job using the job name
message
job.proto:1278GetJob
string id = 1
message
job.proto:1282optional job = 1
rpc GetJobNames (, )
job.proto:193Returns a sequence of job names using search criteria
message
job.proto:1296GetJobNames
optional r = 1
message
job.proto:1301repeated string names = 1
rpc GetJobs (, )
job.proto:190Returns a list of jobs based on specified criteria
message
job.proto:1287GetJobs
optional r = 1
message
job.proto:1291optional jobs = 1
rpc GetLayers (, )
job.proto:196Returns all layer objects
message
job.proto:1306GetLayers
optional job = 1
message
job.proto:1310optional layers = 1
rpc GetUpdatedFrames (, )
job.proto:207Returns a UpdatedFrameCheckResult which contains updated state information for frames that have changed since the last update time as well as the current state of the job. If the user is filtering by layer, passing an array of layer proxies will limit the updates to specific layers. At most, your going to get 1 update per running frame every minute due to memory usage.
message
job.proto:1315GetUpdatedFrames
optional job = 1
int32 last_check = 2
optional layer_filter = 3
message
job.proto:1321JobState state = 1
int32 server_time = 2
optional updated_frames = 3
rpc GetWhatDependsOnThis (, )
job.proto:214Returns a list of dependencies setup to depend on this job. This includes all types of depends, not just OnJob dependencies. This will not return any frame on frame dependencies that are part of a FrameByFrame depend. It will return a single element that represents the entire dependency.
message
job.proto:1328GetWhatDependsOnThis
optional job = 1
message
job.proto:1332optional depends = 1
rpc GetWhatThisDependsOn (, )
job.proto:217Returns a list of dependencies that this frame depends on.
message
job.proto:1337GetWhatThisDependsOn
optional job = 1
message
job.proto:1341optional depends = 1
rpc IsJobPending (, )
job.proto:220Returns true if the job is in the pending state the cue.
message
job.proto:1346IsJobPending
string name = 1
message
job.proto:1350bool value = 1
rpc Kill (, )
job.proto:224Kill the job. This puts the job into the Finished State All running frames are killed, all depends satisfied.
message
job.proto:1355Kill
optional job = 1
string username = 2
string pid = 3
string host_kill = 4
string reason = 5
message
job.proto:1363(message has no fields)
rpc KillFrames (, )
job.proto:227Kills all frames that match the FrameSearchCriteria
message
job.proto:1366KillFrames
optional job = 1
optional req = 2
string username = 3
string pid = 4
string host_kill = 5
string reason = 6
message
job.proto:1375(message has no fields)
rpc LaunchSpec (, )
job.proto:235Launches as a job spec and returns an array of job names that are being launched. This method returns immediately after basic checks. The job could fail to launch of a DB error occurs but that is rare.
message
job.proto:1378LaunchSpec
string spec = 1
message
job.proto:1382repeated string names = 1
rpc LaunchSpecAndWait (, )
job.proto:231Launches a job spec and returns an array of launched jobs. Waits for jobs to be committed to DB. This might time out before jobs are launched.
message
job.proto:1387LaunchSpecAndWait
string spec = 1
message
job.proto:1391optional jobs = 1
rpc MarkAsWaiting (, )
job.proto:238Updates the matching frames from the Depend state to the waiting state
message
job.proto:1396MarkAsWaiting
optional job = 1
optional req = 2
message
job.proto:1401(message has no fields)
rpc MarkDoneFrames (, )
job.proto:241Drops any dependency that requires any frame that matches the FrameSearchCriteria
message
job.proto:1404MarkDoneFrames
optional job = 1
optional req = 2
message
job.proto:1409(message has no fields)
rpc Pause (, )
job.proto:244Pauses the job, which means it no longer gets procs
message
job.proto:1412Pause
optional job = 1
message
job.proto:1416(message has no fields)
rpc ReorderFrames (, )
job.proto:247Reorders the specified frame range on this job
message
job.proto:1419ReorderFrames
optional job = 1
string range = 2
Order order = 3
message
job.proto:1425(message has no fields)
rpc Resume (, )
job.proto:250Resumes a paused job
message
job.proto:1428Resume
optional job = 1
message
job.proto:1432(message has no fields)
rpc RetryFrames (, )
job.proto:253Retries all frames that match the FrameSearchCriteria
message
job.proto:1435RetryFrames
optional job = 1
optional req = 2
message
job.proto:1440(message has no fields)
rpc RunFilters (, )
job.proto:256Rerun filters for this job
message
job.proto:1443RunFilters
optional job = 1
message
job.proto:1447(message has no fields)
rpc SetAutoEat (, )
job.proto:259If set to true, a frame that would have turned dead, will become eaten
message
job.proto:1450SetAutoEat
optional job = 1
bool value = 2
message
job.proto:1455(message has no fields)
rpc SetGroup (, )
job.proto:262Move the job into the specified group
message
job.proto:1458SetGroup
optional job = 1
string group_id = 2
message
job.proto:1463(message has no fields)
rpc SetMaxCores (, )
job.proto:265Sets the maximum number of procs that can run on this job
message
job.proto:1466SetMaxCores
optional job = 1
float val = 2
message
job.proto:1471(message has no fields)
rpc SetMaxGpus (, )
job.proto:276Sets the maximum number of Gpu that can run on this job
message
job.proto:1474SetMaxGpus
optional job = 1
int32 val = 2
message
job.proto:1479(message has no fields)
rpc SetMaxRetries (, )
job.proto:270Sets the default maximum number of frame retries for the job. One a frame has retried this many times it will automatically go to the dead state. The default upper limit on this is 16 retries.
message
job.proto:1482SetMaxRetries
optional job = 1
int32 max_retries = 2
message
job.proto:1487(message has no fields)
rpc SetMinCores (, )
job.proto:273Sets the minimum number of procs that can run on this job
message
job.proto:1490SetMinCores
optional job = 1
float val = 2
message
job.proto:1495(message has no fields)
rpc SetMinGpus (, )
job.proto:279Sets the minimum number of Gpu that can run on this job
message
job.proto:1498SetMinGpus
optional job = 1
int32 val = 2
message
job.proto:1503(message has no fields)
rpc SetPriority (, )
job.proto:282Sets the job priority
message
job.proto:1506SetPriority
optional job = 1
int32 val = 2
message
job.proto:1511(message has no fields)
rpc ShutdownIfCompleted (, )
job.proto:286Shutdown the job if it is completed. This is a workaround for when Cuebot failed to shutdown a job due to database access error.
message
job.proto:1514ShutdownIfCompleted
optional job = 1
message
job.proto:1518(message has no fields)
rpc StaggerFrames (, )
job.proto:289Staggers the specified frame range
message
job.proto:1521StaggerFrames
optional job = 1
string range = 2
int32 stagger = 3
message
job.proto:1527(message has no fields)
service LayerInterface
job.proto:292rpc AddLimit (, )
job.proto:294Add Limit to the Layer
message
job.proto:1532LAYER ---- AddLimit
optional layer = 1
string limit_id = 2
message
job.proto:1537(message has no fields)
rpc AddRenderPartition (, )
job.proto:297Add RenderPartition to Layer
message
job.proto:1540AddRenderPartion
optional layer = 1
string host = 2
int32 threads = 3
int32 max_cores = 4
int64 max_memory = 5
int64 max_gpu_memory = 6
string username = 7
int32 max_gpus = 8
message
job.proto:1551optional render_partition = 1
rpc CreateDependencyOnFrame (, )
job.proto:300Setup and return a LayerOnFrame dependency
message
job.proto:1556CreateDependencyOnFrame
optional layer = 1
optional frame = 2
message
job.proto:1561optional depend = 1
rpc CreateDependencyOnJob (, )
job.proto:303Setup and return a LayerOnJob dependency
message
job.proto:1566CreateDependencyOnJob
optional layer = 1
optional job = 2
message
job.proto:1571optional depend = 1
rpc CreateDependencyOnLayer (, )
job.proto:306Setup and return a LayerOnLayer dependency
message
job.proto:1576CreateDependencyOnLayer
optional layer = 1
optional depend_on_layer = 2
message
job.proto:1581optional depend = 1
Setup and return a FrameByFrame dependency
message
job.proto:1586CreateFrameByFrameDependency
optional layer = 1
optional depend_layer = 2
bool any_frame = 3
message
job.proto:1592optional depend = 1
rpc DropDepends (, )
job.proto:312Drops every dependency that is causing this layer not to run.
message
job.proto:1597DropDepends
optional layer = 1
depend.DependTarget target = 2
message
job.proto:1602(message has no fields)
rpc DropLimit (, )
job.proto:315Drop the limit from the specified layer.
message
job.proto:1605DropLimit
optional layer = 1
string limit_id = 2
message
job.proto:1610(message has no fields)
rpc EatFrames (, )
job.proto:318Eat the Frames of this Layer
message
job.proto:1613EatFrames
optional layer = 1
message
job.proto:1617(message has no fields)
rpc EnableMemoryOptimizer (, )
job.proto:321When disabled, This will stop Cuebot from lowering the amount of memory required for a given layer.
message
job.proto:1620EnableMemoryOptimizer
optional layer = 1
bool value = 2
message
job.proto:1625(message has no fields)
rpc FindLayer (, )
job.proto:324Finds a layer in a pending job based the job and layer name
message
job.proto:1628FindLayer
string job = 1
string layer = 2
message
job.proto:1633optional layer = 1
rpc GetFrames (, )
job.proto:327Get the frames that match the FrameSearchCriteria
message
job.proto:1638GetFrames
optional layer = 1
optional s = 2
message
job.proto:1643optional frames = 1
rpc GetLayer (, )
job.proto:330Finds a layer in a pending job from its unique ID
message
job.proto:1648GetLayer
string id = 1
message
job.proto:1652optional layer = 1
rpc GetLimits (, )
job.proto:333Return a list of the limits on the specified layer.
message
job.proto:1657GetLayer
optional layer = 1
message
job.proto:1661repeated limits = 1
rpc GetOutputPaths (, )
job.proto:336Return a list of all registered output paths.
message
job.proto:1666GetOutputPaths
optional layer = 1
message
job.proto:1670repeated string output_paths = 1
rpc GetWhatDependsOnThis (, )
job.proto:344Returns a list of dependencies setup to depend on this layer. This includes all types of depends, not just OnLayer dependencies. This will not return any frame on frame dependencies that are part of a FrameByFrame depend. It will return a single element that represents the entire dependency.
message
job.proto:1675GetWhatDependsOnThis
optional layer = 1
message
job.proto:1679optional depends = 1
rpc GetWhatThisDependsOn (, )
job.proto:339Returns a list of dependencies that this frame depends on.
message
job.proto:1684GetWhatThisDependsOn
optional layer = 1
message
job.proto:1688optional depends = 1
rpc KillFrames (, )
job.proto:347Kill Frames associated with this layer
message
job.proto:1693KillFrames
optional layer = 1
string username = 2
string pid = 3
string host_kill = 4
string reason = 5
message
job.proto:1701(message has no fields)
rpc MarkdoneFrames (, )
job.proto:350Mark the frames of this layer done
message
job.proto:1704MarkdoneFrames
optional layer = 1
message
job.proto:1708(message has no fields)
rpc RegisterOutputPath (, )
job.proto:353Register an output with the given layer. The output paths are sent in the opencue email.
message
job.proto:1725RegisterOutputPath
optional layer = 1
string spec = 2
message
job.proto:1730(message has no fields)
rpc ReorderFrames (, )
job.proto:356Reorders the specified frame range on this job.
message
job.proto:1733ReorderFrames
optional layer = 1
string range = 2
Order order = 3
message
job.proto:1739(message has no fields)
rpc RetryFrames (, )
job.proto:359Retry the Frames of this Layer
message
job.proto:1711RetryFrames
optional layer = 1
message
job.proto:1715(message has no fields)
rpc SetDispatchOrder (, )
job.proto:362Set the Dispatch Order of this Layer
message
job.proto:1717optional layer = 1
int32 order = 2
message
job.proto:1722(message has no fields)
rpc SetMaxCores (, )
job.proto:366The maximum number of cores to run on a given frame within this layer. Fractional core values are not allowed with this setting.
message
job.proto:1742SetMaxCores
optional layer = 1
float cores = 2
message
job.proto:1747(message has no fields)
rpc SetMaxGpus (, )
job.proto:372The maximum number of Gpu to run on a given frame within this layer.
message
job.proto:1767SetMaxGpus
optional layer = 1
int32 max_gpus = 2
message
job.proto:1772(message has no fields)
rpc SetMinCores (, )
job.proto:369Set the Min Cores for this layer
message
job.proto:1750SetMinCores
optional layer = 1
float cores = 2
message
job.proto:1755(message has no fields)
rpc SetMinGpu (, )
job.proto:381[Deprecated] Set the Min gpu memory value for the layer
message
job.proto:1758[Deprecated] SetMinGpu
optional layer = 1
int64 gpu = 2
message
job.proto:1764[Deprecated]
(message has no fields)
rpc SetMinGpuMemory (, )
job.proto:378Set the Min gpu memory value for the layer
message
job.proto:1783SetMinGpuMemory
optional layer = 1
int64 gpu_memory = 2
message
job.proto:1788(message has no fields)
rpc SetMinGpus (, )
job.proto:375Set the Min Gpus for this layer
message
job.proto:1775SetMinGpus
optional layer = 1
int32 min_gpus = 2
message
job.proto:1780(message has no fields)
rpc SetMinMemory (, )
job.proto:384Set the Min Memory value for the layer
message
job.proto:1791SetMinMemory
optional layer = 1
int64 memory = 2
message
job.proto:1796(message has no fields)
rpc SetStartAfter (, )
job.proto:389Do not book frames of this layer before the given time. Also written automatically by Cuebot's exit-status backoff (dispatcher.layer_delay.rules); an operator-set time is authoritative and replaces any automatic delay.
message
job.proto:1799SetStartAfter
optional layer = 1
int64 start_after = 2
Epoch seconds; 0 clears the delay. See Layer.start_after for why this is int64.
string username = 3
Recorded in the layer's start_after_reason for provenance.
message
job.proto:1807(message has no fields)
rpc SetTags (, )
job.proto:392Set tags on the layer
message
job.proto:1810SetTags
optional layer = 1
repeated string tags = 2
message
job.proto:1815(message has no fields)
rpc SetThreadable (, )
job.proto:395Set whether the layer is threadable or not
message
job.proto:1818SetThreadable
optional layer = 1
bool threadable = 2
message
job.proto:1823(message has no fields)
rpc SetTimeout (, )
job.proto:398Set whether the timeout for frames in the layer
message
job.proto:1826SetTimeout
optional layer = 1
int32 timeout = 2
message
job.proto:1831(message has no fields)
rpc SetTimeoutLLU (, )
job.proto:401Set whether the LLU timeout for frames in the layer
message
job.proto:1834SetTimeoutLLU
optional layer = 1
int32 timeout_llu = 2
message
job.proto:1839(message has no fields)
rpc StaggerFrames (, )
job.proto:404Staggers the specified frame range.
message
job.proto:1843StaggerFrames
optional layer = 1
string range = 2
int32 stagger = 3
message
job.proto:1849(message has no fields)
Define the possible checkpoint states for a frame.
Used in: ,
DISABLED = 0
ENABLED = 1
COPYING = 2
COMPLETE = 3
message
job.proto:507FRAME ----
Used in: , , , , , , , , , , , , , , , , , , , , ,
string id = 1
string name = 2
string layer_name = 3
int32 number = 4
FrameState state = 5
int32 retry_count = 6
int32 exit_status = 7
int32 dispatch_order = 8
int32 start_time = 9
int32 stop_time = 10
int64 max_rss = 11
int64 used_memory = 12
int64 reserved_memory = 13
int64 reserved_gpu_memory = 14
string last_resource = 15
CheckpointState checkpoint_state = 16
int32 checkpoint_count = 17
int32 total_core_time = 18
int32 llu_time = 19
int32 total_gpu_time = 20
int64 max_gpu_memory = 21
int64 used_gpu_memory = 22
optional frame_state_display_override = 23
int64 max_pss = 24
int64 used_pss = 25
int32 eligible_time = 26
int32 submission_time = 27
These frame exit status values are used to trigger special dispatcher behavior. They are greater than 255 so they don't collide with any real exit status values used by applications running on the cue.
SUCCESS = 0
The frame was a success
FAILED_LAUNCH = 256
The frame should be automatically retried
SKIP_RETRY = 286
Retries should not be incremented
message
job.proto:538Object for frame searching
Used in: , , , , , , ,
repeated string ids = 1
repeated string frames = 2
repeated string layers = 3
optional states = 4
string frame_range = 5
string memory_range = 6
string duration_range = 7
int32 page = 8
int32 limit = 9
int32 change_date = 10
int32 max_results = 11
int32 offset = 12
bool include_finished = 13
message
job.proto:555A sequence of Frames
Used in: , ,
repeated frames = 1
Defines the possible states of a frame.
Used in: , , , , , ,
WAITING = 0
Ok to be dispatched
SETUP = 1
Reserved to be dispatched
RUNNING = 2
Running on a render proc
SUCCEEDED = 3
Frame completed successfully
DEPEND = 4
Frame is waiting on a dependency
DEAD = 5
Frame is dead,which means it has died N times
EATEN = 6
Frame is eaten, acts like the frame has succeeded
CHECKPOINT = 7
Frame is checkpointing
message
job.proto:490Object to contain an override of the frame's display settings
Used in: , , ,
FrameState state = 1
the FrameState to override
string text = 2
the text to use
optional color = 3
RGB color to use e.g. 255,0,0
message
job.proto:494Used in:
int32 red = 1
int32 green = 2
int32 blue = 3
message
job.proto:502Used in:
repeated overrides = 1
message
job.proto:560A sequence of FrameStates
Used in:
repeated FrameState frame_states = 1
message
job.proto:599GROUP ----
Used in: , , , , , , , , , , , , , , , , , , , , , , , ,
string id = 1
string name = 2
string department = 3
int32 default_job_priority = 4
float default_job_min_cores = 5
float default_job_max_cores = 6
float min_cores = 7
float max_cores = 8
int32 level = 9
string parent_id = 10
optional group_stats = 11
float default_job_min_gpus = 12
float default_job_max_gpus = 13
float min_gpus = 14
float max_gpus = 15
message
job.proto:617Used in: , ,
repeated groups = 1
message
job.proto:621Used in: ,
int32 running_frames = 1
int32 dead_frames = 2
int32 depend_frames = 3
int32 waiting_frames = 4
int32 pending_jobs = 5
float reserved_cores = 6
float reserved_gpus = 7
message
job.proto:632JOB ----
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
string id = 1
JobState state = 2
string name = 3
string shot = 4
string show = 5
string user = 6
string group = 7
string facility = 8
string os = 9
oneof uid_optional
int32 uid = 10
int32 priority = 11
float min_cores = 12
float max_cores = 13
string log_dir = 14
bool is_paused = 15
bool has_comment = 16
bool auto_eat = 17
int32 start_time = 18
int32 stop_time = 19
optional job_stats = 20
float min_gpus = 21
float max_gpus = 22
string loki_url = 23
int32 eligible_time = 24
message
job.proto:662Use to filter the job search. Please note that by searching for non-pending jobs, the output is limited to 200 jobs
Used in: ,
repeated string ids = 1
repeated string jobs = 2
repeated string regex = 3
repeated string substr = 4
repeated string users = 5
repeated string shots = 6
repeated string shows = 7
bool include_finished = 8
message
job.proto:673Used in: , , , , , ,
repeated jobs = 1
Defines the possible states of a job.
Used in: , , , , , ,
PENDING = 0
Job is running
FINISHED = 1
The job has completed
STARTUP = 2
The job is in the process of starting up
SHUTDOWN = 3
The job is in the process of shutting down
POSTED = 4
The job is a post job and is waiting to go pending
message
job.proto:677Used in: ,
int32 total_layers = 1
int32 total_frames = 2
int32 waiting_frames = 3
int32 running_frames = 4
int32 dead_frames = 5
int32 eaten_frames = 6
int32 depend_frames = 7
int32 succeeded_frames = 8
int32 pending_frames = 9
int32 avg_frame_sec = 10
int32 high_frame_sec = 11
int32 avg_core_sec = 12
int64 rendered_frame_count = 13
int64 failed_frame_count = 14
int64 remaining_core_sec = 15
int64 total_core_sec = 16
int64 rendered_core_sec = 17
int64 failed_core_sec = 18
int64 max_rss = 19
float reserved_cores = 20
int64 total_gpu_sec = 21
int64 rendered_gpu_sec = 22
int64 failed_gpu_sec = 23
float reserved_gpus = 24
int64 max_gpu_memory = 25
int64 max_pss = 26
message
job.proto:707LAYER ----
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
string id = 1
string name = 2
string range = 3
repeated string tags = 4
float min_cores = 5
float max_cores = 6
bool is_threadable = 7
int64 min_memory = 8
int64 min_gpu_memory = 9
int32 chunk_size = 10
int32 dispatch_order = 11
LayerType type = 12
repeated string services = 13
An array of services that are being run on all frames within this layer.
bool memory_optimizer_enabled = 14
True if the memory optimizer is enabled. Disabling the optimizer will stop Cuebot from lowering memory.
optional layer_stats = 15
string parent_id = 16
repeated string limits = 17
int32 timeout = 18
int32 timeout_llu = 19
float min_gpus = 20
float max_gpus = 21
string command = 22
int32 eligible_time = 23
int32 start_time = 24
int32 stop_time = 25
int64 start_after = 26
Do not book frames of this layer before this time. Epoch seconds; 0 = not set. int64 because this is a future timestamp an operator may set past the int32 epoch limit.
string start_after_reason = 27
Free-text provenance for start_after, displayed verbatim.
message
job.proto:742Used in: ,
repeated layers = 1
message
job.proto:746Used in:
int32 total_frames = 1
int32 waiting_frames = 2
int32 running_frames = 3
int32 dead_frames = 4
int32 eaten_frames = 5
int32 depend_frames = 6
int32 succeeded_frames = 7
int32 pending_frames = 8
int32 avg_frame_sec = 9
int32 low_frame_sec = 10
int32 high_frame_sec = 11
int32 avg_core_sec = 12
int64 rendered_frame_count = 13
int64 failed_frame_count = 14
int64 remaining_core_sec = 15
int64 total_core_sec = 16
int64 rendered_core_sec = 17
int64 failed_core_sec = 18
int64 max_rss = 19
float reserved_cores = 20
int64 total_gpu_sec = 21
int64 rendered_gpu_sec = 22
int64 failed_gpu_sec = 23
float reserved_gpus = 24
int64 max_gpu_memory = 25
int64 max_pss = 26
The LayerType determines the type of the layer. A proc will not run frames from different layers UNLESS the layer type is PreProcess or PostProcess. This gives us the ability to run all the preprocesses on one proc and all the post processes on one proc. There is no specific dispatch order for layer types. You will need to setup dependencies.
Used in: ,
PRE = 0
POST = 1
RENDER = 2
UTIL = 3
message
job.proto:776NestedGroup ---
Used in: , ,
string id = 1
string name = 2
string department = 3
int32 default_job_priority = 4
float default_job_min_cores = 5
float default_job_max_cores = 6
float min_cores = 7
float max_cores = 8
int32 level = 9
optional parent = 10
optional groups = 11
repeated string jobs = 12
optional stats = 13
float default_job_min_gpus = 14
float default_job_max_gpus = 15
float min_gpus = 16
float max_gpus = 17
repeated inline_jobs = 18
message
job.proto:797Used in:
repeated nested_groups = 1
message
job.proto:802NESTED JOB ----
string id = 1
JobState state = 2
string name = 3
string shot = 4
string show = 5
string user = 6
string group = 7
string facility = 8
string os = 9
oneof uid_optional
int32 uid = 10
int32 priority = 11
float min_cores = 12
float max_cores = 13
string log_dir = 14
bool is_paused = 15
bool has_comment = 16
bool auto_eat = 17
int32 start_time = 18
int32 stop_time = 19
optional parent = 20
optional stats = 21
float min_gpus = 22
float max_gpus = 23
int32 eligible_time = 24
enum Order
job.proto:477Used for reordering frames.
Used in: ,
FIRST = 0
Moves frames to the lowest dispatch order
LAST = 1
Moves frames to the last dispatch order
REVERSE = 2
Reverses the dispatch order
message
job.proto:567A struct containing properties for all the elements of a frame that can change except for the ID which is there for indexing purposes.
Used in:
string id = 1
FrameState state = 2
int32 retry_count = 3
int32 exit_status = 4
int32 start_time = 5
int32 stop_time = 6
int64 max_rss = 7
int64 used_memory = 8
string last_resource = 9
int32 llu_time = 10
int64 max_gpu_memory = 11
int64 used_gpu_memory = 12
optional frame_state_display_override = 13
int64 max_pss = 14
message
job.proto:592The result of an updated frame check. The job state is included so tools that are just monitoring frames can stop monitoring them once the job state changes to Finished.
JobState state = 1
int32 server_time = 2
optional updated_frames = 3
message
job.proto:584Used in: ,
repeated updated_frames = 1