package job

Mouse Melon logoGet desktop application:
View/edit binary Protocol Buffers messages

service FrameInterface

job.proto:21

service GroupInterface

job.proto:80

service JobInterface

job.proto:142

service LayerInterface

job.proto:292

enum CheckpointState

job.proto:412

Define the possible checkpoint states for a frame.

Used in: Frame, FrameSetCheckpointStateRequest

message Frame

job.proto:508

FRAME ----

Used in: host.ProcGetFrameResponse, FrameAddRenderPartitionRequest, FrameCreateDependencyOnFrameRequest, FrameCreateDependencyOnJobRequest, FrameCreateDependencyOnLayerRequest, FrameDropDependsRequest, FrameEatRequest, FrameFindFrameResponse, FrameGetFrameResponse, FrameGetWhatDependsOnThisRequest, FrameGetWhatThisDependsOnRequest, FrameKillRequest, FrameMarkAsDependRequest, FrameMarkAsWaitingRequest, FrameRetryRequest, FrameSeq, FrameSetCheckpointStateRequest, FrameStateDisplayOverrideRequest, GetFrameStateDisplayOverridesRequest, JobCreateDependencyOnFrameRequest, LayerCreateDependOnFrameRequest, monitoring.FrameEvent

enum FrameExitStatus

job.proto:421

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.

message FrameSearchCriteria

job.proto:539

Object for frame searching

Used in: FrameGetFramesRequest, JobEatFramesRequest, JobGetFramesRequest, JobKillFramesRequest, JobMarkAsWaitingRequest, JobMarkDoneFramesRequest, JobRetryFramesRequest, LayerGetFramesRequest

message FrameSeq

job.proto:556

A sequence of Frames

Used in: FrameGetFramesResponse, JobGetFramesResponse, LayerGetFramesResponse

enum FrameState

job.proto:431

Defines the possible states of a frame.

Used in: Frame, FrameStateDisplayOverride, FrameStateSeq, UpdatedFrame, monitoring.FrameEvent, monitoring.GetFrameHistoryRequest, monitoring.HistoricalFrame

message FrameStateDisplayOverride

job.proto:491

Object to contain an override of the frame's display settings

Used in: Frame, FrameStateDisplayOverrideRequest, FrameStateDisplayOverrideSeq, UpdatedFrame

message FrameStateDisplayOverride.RGB

job.proto:495

Used in: FrameStateDisplayOverride

message FrameStateDisplayOverrideSeq

job.proto:503

Used in: GetFrameStateDisplayOverridesResponse

message FrameStateSeq

job.proto:561

A sequence of FrameStates

Used in: FrameSearchCriteria

message Group

job.proto:600

GROUP ----

Used in: filter.FilterRunFilterOnGroupRequest, host.ProcUnbookToGroupRequest, GroupCreateSubGroupRequest, GroupCreateSubGroupResponse, GroupDeleteRequest, GroupFindGroupResponse, GroupGetGroupResponse, GroupGetGroupsRequest, GroupGetJobsRequest, GroupReparentGroupsRequest, GroupReparentJobsRequest, GroupSeq, GroupSetDefJobMaxCoresRequest, GroupSetDefJobMaxGpusRequest, GroupSetDefJobMinCoresRequest, GroupSetDefJobMinGpusRequest, GroupSetDefJobPriorityRequest, GroupSetDeptRequest, GroupSetGroupRequest, GroupSetMaxCoresRequest, GroupSetMaxGpusRequest, GroupSetMinCoresRequest, GroupSetMinGpusRequest, GroupSetNameRequest, show.ShowGetRootGroupResponse

message GroupSeq

job.proto:618

Used in: GroupGetGroupsResponse, GroupReparentGroupsRequest, show.ShowGetGroupsResponse

message GroupStats

job.proto:622

Used in: Group, NestedGroup

message Job

job.proto:633

JOB ----

Used in: host.ProcGetJobResponse, FrameCreateDependencyOnJobRequest, JobAddCommentRequest, JobAddRenderPartRequest, JobAddSubscriberRequest, JobCreateDependencyOnFrameRequest, JobCreateDependencyOnJobRequest, JobCreateDependencyOnLayerRequest, JobDropDependsRequest, JobEatFramesRequest, JobFindJobResponse, JobGetCommentsRequest, JobGetCurrentRequest, JobGetCurrentResponse, JobGetDependsRequest, JobGetFramesRequest, JobGetJobResponse, JobGetLayersRequest, JobGetUpdatedFramesRequest, JobGetWhatDependsOnThisRequest, JobGetWhatThisDependsOnRequest, JobKillFramesRequest, JobKillRequest, JobMarkAsWaitingRequest, JobMarkDoneFramesRequest, JobPauseRequest, JobReorderFramesRequest, JobResumeRequest, JobRetryFramesRequest, JobRunFiltersRequest, JobSeq, JobSetAutoEatRequest, JobSetGroupRequest, JobSetMaxCoresRequest, JobSetMaxGpusRequest, JobSetMaxRetriesRequest, JobSetMinCoresRequest, JobSetMinGpusRequest, JobSetPriorityRequest, JobShutdownIfCompletedRequest, JobStaggerFramesRequest, LayerCreateDependOnJobRequest, NestedGroup, monitoring.JobEvent

message JobSearchCriteria

job.proto:663

Use to filter the job search. Please note that by searching for non-pending jobs, the output is limited to 200 jobs

Used in: JobGetJobNamesRequest, JobGetJobsRequest

message JobSeq

job.proto:674

Used in: filter.FilterRunFilterOnJobsRequest, host.ProcUnbookToJobRequest, GroupGetJobsResponse, GroupReparentJobsRequest, JobGetJobsResponse, JobLaunchSpecAndWaitResponse, show.ShowGetJobsResponse

enum JobState

job.proto:451

Defines the possible states of a job.

Used in: Job, JobGetUpdatedFramesResponse, NestedJob, UpdatedFrameCheckResult, monitoring.GetJobHistoryRequest, monitoring.HistoricalJob, monitoring.JobEvent

message JobStats

job.proto:678

Used in: Job, NestedJob

message Layer

job.proto:708

LAYER ----

Used in: host.ProcGetLayerResponse, FrameCreateDependencyOnLayerRequest, JobCreateDependencyOnLayerRequest, LayerAddLimitRequest, LayerAddRenderPartitionRequest, LayerCreateDependOnFrameRequest, LayerCreateDependOnJobRequest, LayerCreateDependOnLayerRequest, LayerCreateFrameByFrameDependRequest, LayerDropDependsRequest, LayerDropLimitRequest, LayerEatFramesRequest, LayerEnableMemoryOptimizerRequest, LayerFindLayerResponse, LayerGetFramesRequest, LayerGetLayerResponse, LayerGetLimitsRequest, LayerGetOutputPathsRequest, LayerGetWhatDependsOnThisRequest, LayerGetWhatThisDependsOnRequest, LayerKillFramesRequest, LayerMarkdoneFramesRequest, LayerRegisterOutputPathRequest, LayerReorderFramesRequest, LayerRetryFramesRequest, LayerSeq, LayerSetDispatchOrderRequest, LayerSetMaxCoresRequest, LayerSetMaxGpusRequest, LayerSetMinCoresRequest, LayerSetMinGpuMemoryRequest, LayerSetMinGpuRequest, LayerSetMinGpusRequest, LayerSetMinMemoryRequest, LayerSetStartAfterRequest, LayerSetTagsRequest, LayerSetThreadableRequest, LayerSetTimeoutLLURequest, LayerSetTimeoutRequest, LayerStaggerFramesRequest, monitoring.LayerEvent

message LayerSeq

job.proto:749

Used in: JobGetLayersResponse, JobGetUpdatedFramesRequest

message LayerStats

job.proto:753

Used in: Layer

enum LayerType

job.proto:470

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: Layer, monitoring.HistoricalLayer

message NestedGroup

job.proto:783

NestedGroup ---

Used in: NestedGroupSeq, NestedJob, show.ShowGetJobWhiteboardResponse

message NestedGroupSeq

job.proto:806

Used in: NestedGroup

message NestedJob

job.proto:811

NESTED JOB ----

enum Order

job.proto:478

Used for reordering frames.

Used in: JobReorderFramesRequest, LayerReorderFramesRequest

message UpdatedFrame

job.proto:568

A 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: UpdatedFrameSeq

message UpdatedFrameCheckResult

job.proto:593

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

message UpdatedFrameSeq

job.proto:585

Used in: JobGetUpdatedFramesResponse, UpdatedFrameCheckResult