package com.github.trace_machina.nativelink.remote_execution
Get desktop application:
View/edit binary Protocol Buffers messages
service WorkerApi
worker_api.proto:31/ This API describes how schedulers communicate with Worker nodes. / / When a worker node comes online it must be pre-configured with the / endpoint of the scheduler it will register with. Once the worker / connects to the scheduler it must send a `RegisterSupportedProperties` / command to the scheduler. The scheduler will then use this information / to determine which jobs the worker can process.
rpc ConnectWorker (, stream )
worker_api.proto:36/ Registers this worker and informs the scheduler what properties / this worker supports. The response must be listened on the client / side for updates from the server. The first item sent will always be / a ConnectionResult, after that it is undefined.
message
worker_api.proto:78/ Represents the initial request sent to the scheduler informing the / scheduler about this worker's capabilities and metadata.
repeated properties = 1
/ The list of properties this worker can support. The exact / implementation is driven by the configuration matrix between the / worker and scheduler. / / The scheduler may reject this worker if any property keys that / the scheduler is not configured to support, or may simply ignore / the unsupported properties. / / The details on how to use this property can be found here: / https://github.com/TraceMachina/nativelink/blob/3147265047544572e3483c985e4aab0f9fdded38/nativelink-config/src/cas_server.rs
string worker_id_prefix = 2
/ Prefix to use for worker IDs. This is primarily used for debugging / or for other systems to identify workers. The scheduler will always / append this prefix to the assigned worker_id followed by a UUIDv6.
message
worker_api.proto:140/ Communication from the scheduler to the worker.
oneof update
connection_result = 1
/ This will be sent only as the first item in the stream after the node / has connected.
keep_alive = 2
/ Message used to let the worker know that it is still alive as well / as check to see if the worker is still alive. The worker / may close the connection if the scheduler has not sent any messages / after some amount of time (configured in the scheduler's / configuration).
start_action = 3
/ Informs the worker about some work it should begin performing the / requested action.
disconnect = 4
/ Informs the worker that it has been disconnected from the pool. / The worker may discard any outstanding work that is being executed.
kill_operation_request = 5
/ Instructs the worker to kill a specific running operation.
rpc KeepAlive (, )
worker_api.proto:43/ Message used to let the scheduler know that it is still alive as / well as check to see if the scheduler is still alive. The scheduler / may close the connection if the worker has not sent any messages / after some amount of time (configured in the scheduler's / configuration).
message
worker_api.proto:63/ Request object for keep alive requests.
string worker_id = 1
/ ID of the worker making the request.
rpc GoingAway (, )
worker_api.proto:56/ Informs the scheduler that the service is going offline and / should stop issuing any new actions on this worker. / / The worker may stay connected even after sending this command / and may even send an `ExecuteResult` after sending this command. / It is up to the scheduler implementation to decide how to handle / this case. / / Any job that was running on this instance likely needs to be / executed again, but up to the scheduler on how or when to handle / this case.
message
worker_api.proto:70/ Request object for going away requests.
string worker_id = 1
/ ID of the worker making the request.
rpc ExecutionResponse (, )
worker_api.proto:59/ Informs the scheduler about the result of an execution request.
message
worker_api.proto:100/ The result of an ExecutionRequest.
string worker_id = 1
/ ID of the worker making the request.
string instance_name = 6
/ The `instance_name` this task was initially assigned to. This is set by the client / that initially sent the job as part of the BRE protocol.
string operation_id = 8
/ The operation ID that was executed.
oneof result
/ The actual response data.
execute_response = 4
/ Result of the execution. See `build.bazel.remote.execution.v2.ExecuteResponse` / for details.
internal_error = 5
/ An internal error. This is only present when an internal error happened that / was not recoverable. If the execution job failed but at no fault of the worker / it should not use this field and should send the error via execute_response.
message
worker_api.proto:127/ Result sent back from the server when a node connects.
Used in:
string worker_id = 1
/ The internal ID given to the newly connected node.
message
worker_api.proto:192/ This is a special message used to save actions into the CAS that can be used / by programs like bb_browswer to inspect the history of a build. / Note: Ensure this is always compatible with: / https://github.com/buildbarn/bb-remote-execution/blob/e95e066eb624dc9099682394ec18c12e218e8fc4/pkg/proto/cas/cas.proto#L23
optional action_digest = 1
optional execute_response = 3
message
worker_api.proto:134/ Request to kill a running operation sent from the scheduler to a worker.
Used in:
string operation_id = 1
/ The the operation id for the operation to be killed.
message
worker_api.proto:167Used in: ,
optional execute_request = 1
/ The action information used to execute job.
string operation_id = 4
/ Id of the operation.
optional queued_timestamp = 3
/ The time at which the command was added to the queue to allow population / of the ActionResult.
optional platform = 5
/ The post-computed platform properties that the scheduler has reserved for / the action.
string worker_id = 6
/ The ID of the worker that is executing the action.