package command_server

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Cancel (CancelRequest, CancelResponse)

  command_server.proto:229

  Cancel a currently running Bazel command. May return before the run command actually terminates.

  message CancelRequest

  command_server.proto:182

  Passed to CommandServer.cancel to initiate graceful cancellation of an in-flight command.

  • string cookie = 1

    The client request cookie (see RunRequest.cookie).

  • string command_id = 2

    The id of the command to cancel.

  message CancelResponse

  command_server.proto:190

  • string cookie = 1

    The server response cookie (see RunResponse.cookie).

• rpc Ping (PingRequest, PingResponse)

  command_server.proto:232

  Does not do anything. Used for liveness check.

  message PingRequest

  command_server.proto:196

  Passed to CommandServer.ping to initiate a ping request.

  • string cookie = 1

    The client request cookie (see RunRequest.cookie).

  message PingResponse

  command_server.proto:201

  • string cookie = 1

    The server response cookie (see RunResponse.cookie).

• rpc Run (RunRequest, stream RunResponse)

  command_server.proto:225

  Run a Bazel command. See documentation of argument/return messages for details.

  message RunRequest

  command_server.proto:32

  Passed to CommandServer.run to initiate execution of a Bazel command.

  • string cookie = 1

    Request cookie from the output base of the server. This serves as a rudimentary form of mutual authentication.

  • repeated bytes arg = 2

    Command and command arguments. Does not include startup arguments.

  • bool block_for_lock = 3

    Tells the server whether or not the client is willing to wait for any concurrent in-flight request to complete (there are many commands which may not run concurrently). If false and there are in-flight requests then the server will return an error immediately.

  • bool quiet = 9

    Whether the server should restrict itself to emitting only errors on the console.

  • string client_description = 4

    A simple description of the client for reporting purposes. This value is required.

  • string invocation_policy = 5

    Invocation policy affects how command arguments are interpreted and should be passed separately. This is a proto message, either a human readable String or base64-encoded binary-serialized version of the message. It is not typed directly as an InvocationPolicy message due to distinctions between batch and server mode, so the parsing logic is only in the Java code.

  • repeated StartupOption startup_options = 6

    Startup arguments, in the order they were applied, tagged with where they came from. These options have already been parsed and already have had their effect. This information should only be used for logging.

  • bool preemptible = 7

    Whether the resulting command can be preempted if additional commands are received.

  • repeated google.protobuf.Any command_extensions = 8

    Additional per-command information passed to the server in the form of arbitrary messages which the server may be programmed to recognize and consume. Unrecognized message types are ignored.

  message RunResponse

  command_server.proto:137

  Contains metadata and result data for a command execution.

  • string cookie = 1

    Request cookie from the output base of the server. This serves as a rudimentary form of mutual authentication. Set on every response.

  • bytes standard_output = 2

    Standard out of the command, chunked. May be empty.

  • bytes standard_error = 3

    Standard error of the command, chunked. May be empty.

  • bool finished = 4

    Whether this is the last message of the stream, signals that exit_code is valid.

  • int32 exit_code = 5

    The exit code of the command, only valid when finished is set.

  • string command_id = 6

    Randomly generated command identifier, this may be used to cancel execution of the command by issuing a cancel call. This should be sent to the client as soon as possible. This is not required to be set (non-empty) on every response.

  • bool termination_expected = 7

    Whether the command has shut down the server; if set, the client should wait until the server process dies before finishing.

  • optional ExecRequest exec_request = 8

    A command to exec() after the command invocation finishes. Should only be present if finished is set.

  • optional failure_details.FailureDetail failure_detail = 9

    Fine-grained failure details. Should only be present if finished is set. WARNING: This functionality is experimental and should not be relied on at this time. TODO(mschaller): remove experimental warning

  • repeated google.protobuf.Any command_extensions = 10

    Additional per-command information passed by the server in the form of arbitrary messages.

Description of an environment variable

Used in: ExecRequest

• bytes name = 1

• bytes value = 2

Description of a request by the server to the client to execute a binary after the command invocation finishes.

Used in: RunResponse

• bytes working_directory = 1

• repeated bytes argv = 2

• repeated EnvironmentVariable environment_variable = 3

• repeated bytes environment_variable_to_clear = 4

• bool should_exec = 5

• optional ScriptPath script_path = 6

• repeated PathToReplace path_to_replace = 7

Represents paths to replace to allow localization of an ExecRequest when the build takes place on a different filesystem from where executing the ExecRequest would occur. In addition, the PathToReplace#Type enumeration is also reused to specify the possible base directory for a redirect output. The redirect output will be downloaded under one of the specified base directory in the downstream filesystem. TODO: b/331203854 - Rename this message to reflect both redirect output and ExecRequest use cases.

Used in: ExecRequest

• PathToReplace.Type type = 1

• bytes value = 2

Used in: PathToReplace

• UNSPECIFIED = 0

• OUTPUT_BASE = 1

• BUILD_WORKING_DIRECTORY = 2

• BUILD_WORKSPACE_DIRECTORY = 3

• BUILD_EXECROOT = 6

• TEST_LOG_SUBDIR = 4

• HOME = 5

Represents the --script_path value and the run script contents for relevant run builds.

Used in: ExecRequest

• bytes script_path = 1

• bytes script_contents = 2

Describes metadata necessary for connecting to and managing the server.

• int32 pid = 1

  The server process's pid.

• string address = 2

  Address the CommandServer is listening on. Can be passed directly to grpc to create a connection.

• string request_cookie = 3

  Client request cookie.

• string response_cookie = 4

  Server response cookie.

Contains the a startup option with its source file. Uses bytes to preserve the way the user inputted the arguments, like the args in RunRequest.

Used in: RunRequest

• bytes option = 1

  Startup option in --nullaryflag or --unaryflag=value form.

• bytes source = 2

  Where the option came from, such as an rc file or an empty string for the command line.