package google.devtools.remoteexecution.v1test
Get desktop application:
View/edit binary Protocol Buffers messages
The action cache API is used to query whether a given action has already been performed and, if so, retrieve its result. Unlike the [ContentAddressableStorage][google.devtools.remoteexecution.v1test.ContentAddressableStorage], which addresses blobs by their own content, the action cache addresses the [ActionResult][google.devtools.remoteexecution.v1test.ActionResult] by a digest of the encoded [Action][google.devtools.remoteexecution.v1test.Action] which produced them. The lifetime of entries in the action cache is implementation-specific, but the server SHOULD assume that more recently used entries are more likely to be used again. Additionally, action cache implementations SHOULD ensure that any blobs referenced in the [ContentAddressableStorage][google.devtools.remoteexecution.v1test.ContentAddressableStorage] are still valid when returning a result. As with other services in the Remote Execution API, any call may return an error with a [RetryInfo][google.rpc.RetryInfo] error detail providing information about when the client should retry the request; clients SHOULD respect the information provided.
Retrieve a cached execution result. Errors: * `NOT_FOUND`: The requested `ActionResult` is not in the cache.
message
remote_execution.proto:862A request message for [ActionCache.GetActionResult][google.devtools.remoteexecution.v1test.ActionCache.GetActionResult].
string instance_name = 1
The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
optional action_digest = 2
The digest of the [Action][google.devtools.remoteexecution.v1test.Action] whose result is requested.
Upload a new execution result. This method is intended for servers which implement the distributed cache independently of the [Execution][google.devtools.remoteexecution.v1test.Execution] API. As a result, it is OPTIONAL for servers to implement. Errors: * `NOT_IMPLEMENTED`: This method is not supported by the server. * `RESOURCE_EXHAUSTED`: There is insufficient storage space to add the entry to the cache.
message
remote_execution.proto:877A request message for [ActionCache.UpdateActionResult][google.devtools.remoteexecution.v1test.ActionCache.UpdateActionResult].
string instance_name = 1
The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
optional action_digest = 2
The digest of the [Action][google.devtools.remoteexecution.v1test.Action] whose result is being uploaded.
optional action_result = 3
The [ActionResult][google.devtools.remoteexecution.v1test.ActionResult] to store in the cache.
The CAS (content-addressable storage) is used to store the inputs to and outputs from the execution service. Each piece of content is addressed by the digest of its binary data. Most of the binary data stored in the CAS is opaque to the execution engine, and is only used as a communication medium. In order to build an [Action][google.devtools.remoteexecution.v1test.Action], however, the client will need to also upload the [Command][google.devtools.remoteexecution.v1test.Command] and input root [Directory][google.devtools.remoteexecution.v1test.Directory] for the Action. The Command and Directory messages must be marshalled to wire format and then uploaded under the hash as with any other piece of content. In practice, the input root directory is likely to refer to other Directories in its hierarchy, which must also each be uploaded on their own. For small file uploads the client should group them together and call [BatchUpdateBlobs][google.devtools.remoteexecution.v1test.ContentAddressableStorage.BatchUpdateBlobs] on chunks of no more than 10 MiB. For large uploads, the client must use the [Write method][google.bytestream.ByteStream.Write] of the ByteStream API. The `resource_name` is `{instance_name}/uploads/{uuid}/blobs/{hash}/{size}`, where `instance_name` is as described in the next paragraph, `uuid` is a version 4 UUID generated by the client, and `hash` and `size` are the [Digest][google.devtools.remoteexecution.v1test.Digest] of the blob. The `uuid` is used only to avoid collisions when multiple clients try to upload the same file (or the same client tries to upload the file multiple times at once on different threads), so the client MAY reuse the `uuid` for uploading different blobs. The `resource_name` may optionally have a trailing filename (or other metadata) for a client to use if it is storing URLs, as in `{instance}/uploads/{uuid}/blobs/{hash}/{size}/foo/bar/baz.cc`. Anything after the `size` is ignored. A single server MAY support multiple instances of the execution system, each with their own workers, storage, cache, etc. The exact relationship between instances is up to the server. If the server does, then the `instance_name` is an identifier, possibly containing multiple path segments, used to distinguish between the various instances on the server, in a manner defined by the server. For servers which do not support multiple instances, then the `instance_name` is the empty path and the leading slash is omitted, so that the `resource_name` becomes `uploads/{uuid}/blobs/{hash}/{size}`. When attempting an upload, if another client has already completed the upload (which may occur in the middle of a single upload if another client uploads the same blob concurrently), the request will terminate immediately with a response whose `committed_size` is the full size of the uploaded file (regardless of how much data was transmitted by the client). If the client completes the upload but the [Digest][google.devtools.remoteexecution.v1test.Digest] does not match, an `INVALID_ARGUMENT` error will be returned. In either case, the client should not attempt to retry the upload. For downloading blobs, the client must use the [Read method][google.bytestream.ByteStream.Read] of the ByteStream API, with a `resource_name` of `"{instance_name}/blobs/{hash}/{size}"`, where `instance_name` is the instance name (see above), and `hash` and `size` are the [Digest][google.devtools.remoteexecution.v1test.Digest] of the blob. The lifetime of entries in the CAS is implementation specific, but it SHOULD be long enough to allow for newly-added and recently looked-up entries to be used in subsequent calls (e.g. to [Execute][google.devtools.remoteexecution.v1test.Execution.Execute]). As with other services in the Remote Execution API, any call may return an error with a [RetryInfo][google.rpc.RetryInfo] error detail providing information about when the client should retry the request; clients SHOULD respect the information provided.
Upload many blobs at once. The client MUST NOT upload blobs with a combined total size of more than 10 MiB using this API. Such requests should either be split into smaller chunks or uploaded using the [ByteStream API][google.bytestream.ByteStream], as appropriate. This request is equivalent to calling [UpdateBlob][] on each individual blob, in parallel. The requests may succeed or fail independently. Errors: * `INVALID_ARGUMENT`: The client attempted to upload more than 10 MiB of data. Individual requests may return the following errors, additionally: * `RESOURCE_EXHAUSTED`: There is insufficient disk quota to store the blob. * `INVALID_ARGUMENT`: The [Digest][google.devtools.remoteexecution.v1test.Digest] does not match the provided data.
message
remote_execution.proto:927A request message for [ContentAddressableStorage.BatchUpdateBlobs][google.devtools.remoteexecution.v1test.ContentAddressableStorage.BatchUpdateBlobs].
string instance_name = 1
The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
repeated requests = 2
The individual upload requests.
message
remote_execution.proto:941A response message for [ContentAddressableStorage.BatchUpdateBlobs][google.devtools.remoteexecution.v1test.ContentAddressableStorage.BatchUpdateBlobs].
repeated responses = 1
The responses to the requests.
Determine if blobs are present in the CAS. Clients can use this API before uploading blobs to determine which ones are already present in the CAS and do not need to be uploaded again. There are no method-specific errors.
message
remote_execution.proto:896A request message for [ContentAddressableStorage.FindMissingBlobs][google.devtools.remoteexecution.v1test.ContentAddressableStorage.FindMissingBlobs].
string instance_name = 1
The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
repeated blob_digests = 2
A list of the blobs to check.
message
remote_execution.proto:910A response message for [ContentAddressableStorage.FindMissingBlobs][google.devtools.remoteexecution.v1test.ContentAddressableStorage.FindMissingBlobs].
repeated missing_blob_digests = 2
A list of the blobs requested *not* present in the storage.
rpc GetTree (, )
remote_execution.proto:267Fetch the entire directory tree rooted at a node. This request must be targeted at a [Directory][google.devtools.remoteexecution.v1test.Directory] stored in the [ContentAddressableStorage][google.devtools.remoteexecution.v1test.ContentAddressableStorage] (CAS). The server will enumerate the `Directory` tree recursively and return every node descended from the root. The exact traversal order is unspecified and, unless retrieving subsequent pages from an earlier request, is not guaranteed to be stable across multiple invocations of `GetTree`. If part of the tree is missing from the CAS, the server will return the portion present and omit the rest. * `NOT_FOUND`: The requested tree root is not present in the CAS.
message
remote_execution.proto:957A request message for [ContentAddressableStorage.GetTree][google.devtools.remoteexecution.v1test.ContentAddressableStorage.GetTree].
string instance_name = 1
The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
optional root_digest = 2
The digest of the root, which must be an encoded [Directory][google.devtools.remoteexecution.v1test.Directory] message stored in the [ContentAddressableStorage][google.devtools.remoteexecution.v1test.ContentAddressableStorage].
int32 page_size = 3
A maximum page size to request. If present, the server will request no more than this many items. Regardless of whether a page size is specified, the server may place its own limit on the number of items to be returned and require the client to retrieve more items using a subsequent request.
string page_token = 4
A page token, which must be a value received in a previous [GetTreeResponse][google.devtools.remoteexecution.v1test.GetTreeResponse]. If present, the server will use it to return the following page of results.
message
remote_execution.proto:985A response message for [ContentAddressableStorage.GetTree][google.devtools.remoteexecution.v1test.ContentAddressableStorage.GetTree].
repeated directories = 1
The directories descended from the requested root.
string next_page_token = 2
If present, signifies that there are more results which the client can retrieve by passing this as the page_token in a subsequent [request][google.devtools.remoteexecution.v1test.GetTreeRequest]. If empty, signifies that this is the last page of results.
The Remote Execution API is used to execute an [Action][google.devtools.remoteexecution.v1test.Action] on the remote workers. As with other services in the Remote Execution API, any call may return an error with a [RetryInfo][google.rpc.RetryInfo] error detail providing information about when the client should retry the request; clients SHOULD respect the information provided.
rpc Execute (, )
remote_execution.proto:104Execute an action remotely. In order to execute an action, the client must first upload all of the inputs, as well as the [Command][google.devtools.remoteexecution.v1test.Command] to run, into the [ContentAddressableStorage][google.devtools.remoteexecution.v1test.ContentAddressableStorage]. It then calls `Execute` with an [Action][google.devtools.remoteexecution.v1test.Action] referring to them. The server will run the action and eventually return the result. The input `Action`'s fields MUST meet the various canonicalization requirements specified in the documentation for their types so that it has the same digest as other logically equivalent `Action`s. The server MAY enforce the requirements and return errors if a non-canonical input is received. It MAY also proceed without verifying some or all of the requirements, such as for performance reasons. If the server does not verify the requirement, then it will treat the `Action` as distinct from another logically equivalent action if they hash differently. Returns a [google.longrunning.Operation][google.longrunning.Operation] describing the resulting execution, with eventual `response` [ExecuteResponse][google.devtools.remoteexecution.v1test.ExecuteResponse]. The `metadata` on the operation is of type [ExecuteOperationMetadata][google.devtools.remoteexecution.v1test.ExecuteOperationMetadata]. To query the operation, you can use the [Operations API][google.longrunning.Operations.GetOperation]. If you wish to allow the server to stream operations updates, rather than requiring client polling, you can use the [Watcher API][google.watcher.v1.Watcher.Watch] with the Operation's `name` as the `target`. When using the Watcher API, the initial `data` will be the `Operation` at the time of the request. Updates will be provided periodically by the server until the `Operation` completes, at which point the response message will (assuming no error) be at `data.response`. The server NEED NOT implement other methods or functionality of the Operation and Watcher APIs. Errors discovered during creation of the `Operation` will be reported as gRPC Status errors, while errors that occurred while running the action will be reported in the `status` field of the `ExecuteResponse`. The server MUST NOT set the `error` field of the `Operation` proto. The possible errors include: * `INVALID_ARGUMENT`: One or more arguments are invalid. * `FAILED_PRECONDITION`: One or more errors occurred in setting up the action requested, such as a missing input or command or no worker being available. The client may be able to fix the errors and retry. * `RESOURCE_EXHAUSTED`: There is insufficient quota of some resource to run the action. * `UNAVAILABLE`: Due to a transient condition, such as all workers being occupied (and the server does not support a queue), the action could not be started. The client should retry. * `INTERNAL`: An internal error occurred in the execution engine or the worker. * `DEADLINE_EXCEEDED`: The execution timed out. In the case of a missing input or command, the server SHOULD additionally send a [PreconditionFailure][google.rpc.PreconditionFailure] error detail where, for each requested blob not present in the CAS, there is a `Violation` with a `type` of `MISSING` and a `subject` of `"blobs/{hash}/{size}"` indicating the digest of the missing blob.
message
remote_execution.proto:748A request message for [Execution.Execute][google.devtools.remoteexecution.v1test.Execution.Execute].
string instance_name = 1
The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
optional action = 2
The action to be performed.
bool skip_cache_lookup = 3
If true, the action will be executed anew even if its result was already present in the cache. If false, the result may be served from the [ActionCache][google.devtools.remoteexecution.v1test.ActionCache].
int32 total_input_file_count = 4
DEPRECATED: This field should be ignored by clients and servers and will be removed.
int64 total_input_file_bytes = 5
DEPRECATED: This field should be ignored by clients and servers and will be removed.
message
remote_execution.proto:291An `Action` captures all the information about an execution which is required to reproduce it. `Action`s are the core component of the [Execution] service. A single `Action` represents a repeatable action that can be performed by the execution service. `Action`s can be succinctly identified by the digest of their wire format encoding and, once an `Action` has been executed, will be cached in the action cache. Future requests can then use the cached result rather than needing to run afresh. When a server completes execution of an [Action][google.devtools.remoteexecution.v1test.Action], it MAY choose to cache the [result][google.devtools.remoteexecution.v1test.ActionResult] in the [ActionCache][google.devtools.remoteexecution.v1test.ActionCache] unless `do_not_cache` is `true`. Clients SHOULD expect the server to do so. By default, future calls to [Execute][] the same `Action` will also serve their results from the cache. Clients must take care to understand the caching behaviour. Ideally, all `Action`s will be reproducible so that serving a result from cache is always desirable and correct.
Used in:
optional command_digest = 1
The digest of the [Command][google.devtools.remoteexecution.v1test.Command] to run, which MUST be present in the [ContentAddressableStorage][google.devtools.remoteexecution.v1test.ContentAddressableStorage].
optional input_root_digest = 2
The digest of the root [Directory][google.devtools.remoteexecution.v1test.Directory] for the input files. The files in the directory tree are available in the correct location on the build machine before the command is executed. The root directory, as well as every subdirectory and content blob referred to, MUST be in the [ContentAddressableStorage][google.devtools.remoteexecution.v1test.ContentAddressableStorage].
repeated string output_files = 3
A list of the output files that the client expects to retrieve from the action. Only the listed files, as well as directories listed in `output_directories`, will be returned to the client as output. Other files that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes).
repeated string output_directories = 4
A list of the output directories that the client expects to retrieve from the action. Only the contents of the indicated directories (recursively including the contents of their subdirectories) will be returned, as well as files listed in `output_files`. Other files that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. The special value of empty string is allowed, although not recommended, and can be used to capture the entire working directory tree, including inputs. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes).
optional platform = 5
The platform requirements for the execution environment. The server MAY choose to execute the action on any worker satisfying the requirements, so the client SHOULD ensure that running the action on any such worker will have the same result.
optional timeout = 6
A timeout after which the execution should be killed. If the timeout is absent, then the client is specifying that the execution should continue as long as the server will let it. The server SHOULD impose a timeout if the client does not specify one, however, if the client does specify a timeout that is longer than the server's maximum timeout, the server MUST reject the request. The timeout is a part of the [Action][google.devtools.remoteexecution.v1test.Action] message, and therefore two `Actions` with different timeouts are different, even if they are otherwise identical. This is because, if they were not, running an `Action` with a lower timeout than is required might result in a cache hit from an execution run with a longer timeout, hiding the fact that the timeout is too short. By encoding it directly in the `Action`, a lower timeout will result in a cache miss and the execution timeout will fail immediately, rather than whenever the cache entry gets evicted.
bool do_not_cache = 7
If true, then the `Action`'s result cannot be cached.
message
remote_execution.proto:580An ActionResult represents the result of an [Action][google.devtools.remoteexecution.v1test.Action] being run.
Used as response type in: ActionCache.GetActionResult, ActionCache.UpdateActionResult
Used as field type in: ,
repeated output_files = 2
The output files of the action. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present in the output list. If the action does not produce the requested output, or produces a directory where a regular file is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted.
repeated output_directories = 3
The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a [Tree][google.devtools.remoteexecution.v1test.Tree] message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ```
int32 exit_code = 4
The exit code of the command.
bytes stdout_raw = 5
The standard output buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stdout_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either.
optional stdout_digest = 6
The digest for a blob containing the standard output of the action, which can be retrieved from the [ContentAddressableStorage][google.devtools.remoteexecution.v1test.ContentAddressableStorage]. See `stdout_raw` for when this will be set.
bytes stderr_raw = 7
The standard error buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stderr_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either.
optional stderr_digest = 8
The digest for a blob containing the standard error of the action, which can be retrieved from the [ContentAddressableStorage][google.devtools.remoteexecution.v1test.ContentAddressableStorage]. See `stderr_raw` for when this will be set.
message
remote_execution.proto:943A response corresponding to a single blob that the client tried to upload.
Used in:
optional blob_digest = 1
The digest to which this response corresponds.
optional status = 2
The result of attempting to upload that blob.
message
remote_execution.proto:375A `Command` is the actual command executed by a worker running an [Action][google.devtools.remoteexecution.v1test.Action]. Except as otherwise required, the environment (such as which system libraries or binaries are available, and what filesystems are mounted where) is defined by and specific to the implementation of the remote execution API.
repeated string arguments = 1
The arguments to the command. The first argument must be the path to the executable, which must be either a relative path, in which case it is evaluated with respect to the input root, or an absolute path. The working directory will always be the input root.
repeated environment_variables = 2
The environment variables to set when running the program. The worker may provide its own default environment variables; these defaults can be overridden using this field. Additional variables can also be specified. In order to ensure that equivalent `Command`s always hash to the same value, the environment variables MUST be lexicographically sorted by name. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes.
message
remote_execution.proto:378An `EnvironmentVariable` is one variable to set in the running program's environment.
Used in:
string name = 1
The variable name.
string value = 2
The variable value.
message
remote_execution.proto:569A content digest. A digest for a given blob consists of the size of the blob and its hash. The hash algorithm to use is defined by the server, but servers SHOULD use SHA-256. The size is considered to be an integral part of the digest and cannot be separated. That is, even if the `hash` field is correctly specified but `size_bytes` is not, the server MUST reject the request. The reason for including the size in the digest is as follows: in a great many cases, the server needs to know the size of the blob it is about to work with prior to starting an operation with it, such as flattening Merkle tree structures or streaming it to a worker. Technically, the server could implement a separate metadata store, but this results in a significantly more complicated implementation as opposed to having the client specify the size up-front (or storing the size along with the digest in every message where digests are embedded). This does mean that the API leaks some implementation details of (what we consider to be) a reasonable server implementation, but we consider this to be a worthwhile tradeoff. When a `Digest` is used to refer to a proto message, it always refers to the message in binary encoded form. To ensure consistent hashing, clients and servers MUST ensure that they serialize messages according to the following rules, even if there are alternate valid encodings for the same message. - Fields are serialized in tag order. - There are no unknown fields. - There are no duplicate fields. - Fields are serialized according to the default semantics for their type. Most protocol buffer implementations will always follow these rules when serializing, but care should be taken to avoid shortcuts. For instance, concatenating two messages to merge them may produce duplicate fields.
Used in: , , , , , , , , , , , , , ,
string hash = 1
The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long.
int64 size_bytes = 2
The size of the blob, in bytes.
message
remote_execution.proto:504A `Directory` represents a directory node in a file tree, containing zero or more children [FileNodes][google.devtools.remoteexecution.v1test.FileNode] and [DirectoryNodes][google.devtools.remoteexecution.v1test.DirectoryNode]. Each `Node` contains its name in the directory, the digest of its content (either a file blob or a `Directory` proto), as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: - Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. - Each child in the directory must have a unique path segment (file name). - The files and directories in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ```
Used in: ,
repeated files = 1
The files in the directory.
repeated directories = 2
The subdirectories in the directory.
message
remote_execution.proto:527A `DirectoryNode` represents a child of a [Directory][google.devtools.remoteexecution.v1test.Directory] which is itself a `Directory` and its associated metadata.
Used in:
string name = 1
The name of the directory.
optional digest = 2
The digest of the [Directory][google.devtools.remoteexecution.v1test.Directory] object represented. See [Digest][google.devtools.remoteexecution.v1test.Digest] for information about how to take the digest of a proto message.
message
remote_execution.proto:825Metadata about an ongoing [execution][google.devtools.remoteexecution.v1test.Execution.Execute], which will be contained in the [metadata field][google.longrunning.Operation.response] of the [Operation][google.longrunning.Operation].
ExecuteOperationMetadata.Stage stage = 1
optional action_digest = 2
The digest of the [Action][google.devtools.remoteexecution.v1test.Action] being executed.
string stdout_stream_name = 3
If set, the client can use this name with [ByteStream.Read][google.bytestream.ByteStream.Read] to stream the standard output.
string stderr_stream_name = 4
If set, the client can use this name with [ByteStream.Read][google.bytestream.ByteStream.Read] to stream the standard error.
The current stage of execution.
Used in:
UNKNOWN = 0
CACHE_CHECK = 1
Checking the result against the cache.
QUEUED = 2
Currently idle, awaiting a free machine to execute.
EXECUTING = 3
Currently being executed by a worker.
COMPLETED = 4
Finished execution.
message
remote_execution.proto:791The response message for [Execution.Execute][google.devtools.remoteexecution.v1test.Execution.Execute], which will be contained in the [response field][google.longrunning.Operation.response] of the [Operation][google.longrunning.Operation].
optional result = 1
The result of the action.
bool cached_result = 2
True if the result was served from cache, false if it was executed.
optional status = 3
If the status has a code other than `OK`, it indicates that the action did not finish execution. For example, if the operation times out during execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST use this field for errors in execution, rather than the error field on the `Operation` object. If the status code is other than `OK`, then the result MUST NOT be cached. For an error status, the `result` field is optional; the server may populate the output-, stdout-, and stderr-related fields if it has any information available, such as the stdout and stderr of a timed-out action.
map<string, > server_logs = 4
An optional list of additional log outputs the server wishes to provide. A server can use this to return execution-specific logs however it wishes. This is intended primarily to make it easier for users to debug issues that may be outside of the actual job execution, such as by identifying the worker executing the action or by providing logs from the worker's setup phase. The keys SHOULD be human readable so that a client can display them to a user.
message
remote_execution.proto:513A `FileNode` represents a single file and associated metadata.
Used in:
string name = 1
The name of the file.
optional digest = 2
The digest of the file's content.
bool is_executable = 4
True if file is executable, false otherwise.
message
remote_execution.proto:774A `LogFile` is a log stored in the CAS.
Used in:
optional digest = 1
The digest of the log contents.
bool human_readable = 2
This is a hint as to the purpose of the log, and is set to true if the log is human-readable text that can be usefully displayed to a user, and false otherwise. For instance, if a command-line client wishes to print the server logs to the terminal for a failed action, this allows it to avoid displaying a binary file.
message
remote_execution.proto:730An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file.
Used in:
string path = 1
The full path of the directory relative to the working directory. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. The empty string value is allowed, and it denotes the entire working directory.
optional digest = 2
DEPRECATED: This field is deprecated and should no longer be used.
optional tree_digest = 3
The digest of the encoded [Tree][google.devtools.remoteexecution.v1test.Tree] proto containing the directory's contents.
message
remote_execution.proto:689An `OutputFile` is similar to a [FileNode][google.devtools.remoteexecution.v1test.FileNode], but it is tailored for output as part of an `ActionResult`. It allows a full file path rather than only a name, and allows the server to include content inline. `OutputFile` is binary-compatible with `FileNode`.
Used in:
string path = 1
The full path of the file relative to the input root, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash.
optional digest = 2
The digest of the file's content.
bytes content = 3
The raw content of the file. This field may be used by the server to provide the content of a file inline in an [ActionResult][google.devtools.remoteexecution.v1test.ActionResult] and avoid requiring that the client make a separate call to [ContentAddressableStorage.GetBlob] to retrieve it. The client SHOULD NOT assume that it will get raw content with any request, and always be prepared to retrieve it via `digest`.
bool is_executable = 4
True if file is executable, false otherwise.
message
remote_execution.proto:411A `Platform` is a set of requirements, such as hardware, operating system, or compiler toolchain, for an [Action][google.devtools.remoteexecution.v1test.Action]'s execution environment. A `Platform` is represented as a series of key-value pairs representing the properties that are required of the platform. This message is currently being redeveloped since it is an overly simplistic model of platforms.
Used in:
repeated properties = 1
The properties that make up this platform. In order to ensure that equivalent `Platform`s always hash to the same value, the properties MUST be lexicographically sorted by name, and then by value. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes.
message
remote_execution.proto:429A single property for the environment. The server is responsible for specifying the property `name`s that it accepts. If an unknown `name` is provided in the requirements for an [Action][google.devtools.remoteexecution.v1test.Action], the server SHOULD reject the execution request. If permitted by the server, the same `name` may occur multiple times. The server is also responsible for specifying the interpretation of property `value`s. For instance, a property describing how much RAM must be available may be interpreted as allowing a worker with 16GB to fulfill a request for 8GB, while a property describing the OS environment on which the action must be performed may require an exact match with the worker's OS. The server MAY use the `value` of one or more properties to determine how it sets up the execution environment, such as by making specific system files available to the worker.
Used in:
string name = 1
The property name.
string value = 2
The property value.
message
remote_execution.proto:1011An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: name: google.devtools.remoteexecution.v1test.requestmetadata-bin contents: the base64 encoded binary RequestMetadata message.
optional tool_details = 1
The details for the tool invoking the requests.
string action_id = 2
An identifier that ties multiple requests to the same action. For example, multiple requests to the CAS, Action Cache, and Execution API are used in order to compile foo.cc.
string tool_invocation_id = 3
An identifier that ties multiple actions together to a final result. For example, multiple actions are required to build and run foo_test.
string correlated_invocations_id = 4
An identifier to tie multiple tool invocations together. For example, runs of foo_test, bar_test and baz_test on a post-submit of a given patch.
message
remote_execution.proto:997Details for the tool used to call the API.
Used in:
string tool_name = 1
Name of the tool, e.g. bazel.
string tool_version = 2
Version of the tool used for the request, e.g. 5.0.3.
message
remote_execution.proto:717A `Tree` contains all the [Directory][google.devtools.remoteexecution.v1test.Directory] protos in a single directory Merkle tree, compressed into one message.
optional root = 1
The root directory in the tree.
repeated children = 2
All the child directories: the directories referred to by the root and, recursively, all its children. In order to reconstruct the directory tree, the client must take the digests of each of the child directories and then build up a tree starting from the `root`.
message
remote_execution.proto:917A single request message for [ContentAddressableStorage.BatchUpdateBlobs][google.devtools.remoteexecution.v1test.ContentAddressableStorage.BatchUpdateBlobs].
Used in:
optional content_digest = 1
The digest of the blob. This MUST be the digest of `data`.
bytes data = 2
The raw binary data.