package modal.task_command_router
Get desktop application:
View/edit binary Protocol Buffers messages
Poll for the exit status of an exec'd command.
message
task_command_router.proto:33string task_id = 1
The ID of the task running the exec'd command.
string exec_id = 2
The execution ID of the command to wait on.
message
task_command_router.proto:42The response to a TaskExecPollRequest. If the exec'd command has not completed, exit_status will be unset.
oneof exit_status
int32 code = 1
The exit code of the command.
int32 signal = 2
The signal that terminated the command.
Execute a command in the task.
message
task_command_router.proto:53string task_id = 1
The ID of the task to execute the command in.
string exec_id = 2
Execution ID. This ID will be used to identify the execution for other requests and ensure exec commands are idempotent.
repeated string command_args = 3
Command arguments to execute.
TaskExecStdoutConfig stdout_config = 4
Configures how the stdout of the command will be handled.
TaskExecStderrConfig stderr_config = 5
Configures how the stderr of the command will be handled.
optional uint32 timeout_secs = 6
Timeout in seconds for the exec'd command to exit. If the command does not exit within this duration, the command will be killed. This is NOT the timeout for the ExecStartRequest RPC to complete.
optional string workdir = 7
Working directory for the command.
repeated string secret_ids = 8
Secret IDs to mount into the task.
optional pty_info = 9
PTY info for the command.
bool runtime_debug = 10
Enable debugging capabilities on the container runtime. Used only for internal debugging.
message
task_command_router.proto:80(message has no fields)
Write to the stdin stream of an exec'd command.
message
task_command_router.proto:82string task_id = 1
The ID of the task running the exec'd command.
string exec_id = 2
The execution ID of the command to write to.
uint64 offset = 3
The offset to start writing to. This is used to resume writing from the last write position if the connection is closed and reopened.
bytes data = 4
bool eof = 5
If true, close the stdin stream after writing any provided data. This signals EOF to the exec'd process.
message
task_command_router.proto:96(message has no fields)
rpc TaskExecStdioRead (, stream )
task_command_router.proto:141Get a stream of output from the stdout or stderr stream of an exec'd command.
message
task_command_router.proto:98string task_id = 1
The ID of the task running the exec'd command.
string exec_id = 2
The execution ID of the command to read from.
uint64 offset = 3
The offset to start reading from. This is used to resume reading from the last read position if the connection is closed and reopened.
TaskExecStdioFileDescriptor file_descriptor = 4
Which file descriptor to read from.
message
task_command_router.proto:110bytes data = 1
The data read from the file descriptor.
Wait for an exec'd command to exit and return the exit code.
message
task_command_router.proto:115string task_id = 1
The ID of the task running the exec'd command.
string exec_id = 2
The execution ID of the command to wait on.
message
task_command_router.proto:122oneof exit_status
int32 code = 1
The exit code of the command.
int32 signal = 2
The signal that terminated the command.
Used in:
TASK_EXEC_STDERR_CONFIG_DEVNULL = 0
The output will be discarded.
TASK_EXEC_STDERR_CONFIG_PIPE = 1
The output will be streamed to the client.
TASK_EXEC_STDERR_CONFIG_STDOUT = 2
A special value that can be used to indicate that the stderr stream should be merged with the stdout stream.
Used in:
TASK_EXEC_STDIO_FILE_DESCRIPTOR_STDOUT = 0
Read from stdout.
TASK_EXEC_STDIO_FILE_DESCRIPTOR_STDERR = 1
Read from stderr.
Used in:
TASK_EXEC_STDOUT_CONFIG_DEVNULL = 0
The output will be discarded.
TASK_EXEC_STDOUT_CONFIG_PIPE = 1
The output will be streamed to the client.