package rqd
Get desktop application:
View/edit binary Protocol Buffers messages
service RqdInterface
rqd.proto:18Implemented by the Rqd server. Called by cuebot and tools.
rpc GetRunFrame (, )
rqd.proto:20[Deprecated] Return the RunFrame by id
message
rqd.proto:146RQD STATIC ---- GetRunFrame
string frame_id = 1
string job_id = 2
string layer_id = 3
int32 run_frame_id = 4
message
rqd.proto:153optional run_frame = 1
rpc GetRunningFrameStatus (, )
rqd.proto:23Return the RunningFrameStatus report
message
rqd.proto:158GetRunningFrameStatus
string frame_id = 1
message
rqd.proto:162optional running_frame_info = 1
rpc KillRunningFrame (, )
rqd.proto:26Kill the running frame by frame id
message
rqd.proto:167KillRunningFrame
string frame_id = 1
string message = 2
message
rqd.proto:172(message has no fields)
rpc LaunchFrame (, )
rqd.proto:29Launch a new running frame
message
rqd.proto:175LaunchFrame
optional run_frame = 1
message
rqd.proto:179(message has no fields)
rpc Lock (, )
rqd.proto:32Lock a number of cores
message
rqd.proto:187Lock
int32 cores = 1
message
rqd.proto:191(message has no fields)
rpc LockAll (, )
rqd.proto:35Lock all
message
rqd.proto:182LockAll
(message has no fields)
message
rqd.proto:184(message has no fields)
rpc NimbyOff (, )
rqd.proto:38Disable NIMBY on host
message
rqd.proto:194NimbyOff
(message has no fields)
message
rqd.proto:196(message has no fields)
rpc NimbyOn (, )
rqd.proto:41Enable NIMBY on host
message
rqd.proto:199NimbyOn
(message has no fields)
message
rqd.proto:201(message has no fields)
rpc RebootIdle (, )
rqd.proto:44Reboot the host when it becomes idle
message
rqd.proto:204RebootIdle
(message has no fields)
message
rqd.proto:206(message has no fields)
rpc RebootNow (, )
rqd.proto:47[Deprecated] Reboot the host now
message
rqd.proto:209RebootNow
(message has no fields)
message
rqd.proto:211(message has no fields)
rpc ReportStatus (, )
rqd.proto:50Return the HostReport
message
rqd.proto:214ReportStatus
(message has no fields)
message
rqd.proto:216optional host_report = 1
rpc RestartRqdIdle (, )
rqd.proto:56Restart the rqd service once the host becomes idle (no running frames and no unreported frame completions). Cores are locked so no new frames are booked while waiting; UnlockAll aborts the request. Fails with FAILED_PRECONDITION when rqd is not running under a service supervisor able to bring it back up.
message
rqd.proto:221RestartIdle
(message has no fields)
message
rqd.proto:223(message has no fields)
rpc RestartRqdNow (, )
rqd.proto:62Restart the rqd service now. Running frames are not killed; they are recovered by the restarted service through its frame recovery mechanism. Fails with FAILED_PRECONDITION when the restart cannot work as advertised: no service supervisor, frame recovery disabled, or frames running on docker.
message
rqd.proto:226RestartNow
(message has no fields)
message
rqd.proto:228(message has no fields)
rpc ShutdownRqdIdle (, )
rqd.proto:65[Deprecated] Turn off rqd when it becomes idle
message
rqd.proto:231ShutdownIdle
(message has no fields)
message
rqd.proto:233(message has no fields)
rpc ShutdownRqdNow (, )
rqd.proto:68Stop rqd now
message
rqd.proto:236ShutdownNow
(message has no fields)
message
rqd.proto:238(message has no fields)
rpc Unlock (, )
rqd.proto:71Unlock a number of cores
message
rqd.proto:241Unlock
int32 cores = 1
message
rqd.proto:245(message has no fields)
rpc UnlockAll (, )
rqd.proto:74Unlock all cores
message
rqd.proto:248UnlockAll
(message has no fields)
message
rqd.proto:250(message has no fields)
service RunningFrame
rqd.proto:78Implemented by the Rqd server. Called by cuebot and tools.
rpc Kill (, )
rqd.proto:80Kill the provided running frame
message
rqd.proto:254RUNNING FRAME ---- Kill
optional run_frame = 1
string message = 2
message
rqd.proto:259(message has no fields)
rpc Status (, )
rqd.proto:83Get the status of the running frame
message
rqd.proto:262Status
optional run_frame = 1
message
rqd.proto:266optional running_frame_info = 1
SUCCESS = 0
UNKNOWN = 1
message
rqd.proto:97Used in: , , , ,
string resource_id = 1
string job_id = 2
string job_name = 3
string frame_id = 4
string frame_name = 5
string layer_id = 6
string command = 7
string user_name = 8
string log_dir = 9
string show = 10
string shot = 11
string job_temp_dir = 12
Deprecated: Not reliable and will not be taken on consideration moving forward
string frame_temp_dir = 13
Deprecated: Not reliable and will not be taken on consideration moving forward
string log_file = 14
Deprecated: The log_path is defined rqd using job_dir, job_name and frame_name. This field is misleading as it doesn't give cuebot the power to define the log path
string log_dir_file = 15
Deprecated: The log_path is defined rqd using job_dir, job_name and frame_name. This field is misleading as it doesn't give cuebot the power to define the log path
int64 start_time = 16
oneof uid_optional
int32 uid = 17
int32 num_cores = 18
int32 gid = 19
bool ignore_nimby = 20
map<string, string> environment = 21
map<string, string> attributes = 22
int32 num_gpus = 23
optional children = 24
string os = 25
int64 soft_memory_limit = 26
int64 hard_memory_limit = 27
int32 pid = 28
string loki_url = 29
message
rqd.proto:137repeated run_frames = 1