package build.buildgrid
Get desktop application:
View/edit binary Protocol Buffers messages
rpc CaptureFiles (, )
local_cas.proto:139Capture files from the local filesystem. This imports the specified paths from the local filesystem into CAS. If a CAS remote is configured, the blobs are uploaded. The `bypass_local_cache` parameter is a hint to indicate whether the blobs shall be uploaded without first storing them in the local cache. The `move_files` parameter is a hint to indicate that the files could be moved into the storage. This can make capturing more efficient by avoiding copies when it is known that files will not be needed after they are imported. If a server chooses not to move them, the source files will still exist after this request. The `skip_upload` parameter is a hint to indicate that the files do not need to be uploaded to the remote CAS. This can be useful for local-only workflows where an upload step adds unnecessary latency.
message
local_cas.proto:465A request message for [LocalContentAddressableStorage.CaptureFiles][build.buildgrid.v2.LocalContentAddressableStorage.CaptureFiles].
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.
string root = 6
The optional root path to restrict capture to a subtree. If specified, `path` will be resolved inside this root. No files outside the root will be captured.
repeated string path = 2
The path(s) in the local filesystem to capture.
bool bypass_local_cache = 3
This is a hint whether the blobs shall be uploaded to the remote CAS without first storing them in the local cache.
repeated string node_properties = 4
The properties of path(s) in the local filesystem to capture.
bool move_files = 5
Hints whether the files can be moved into the storage. If enabled, they MUST NOT be modified after issuing this request in order to guarantee consistency.
bool skip_upload = 7
Hints whether files should be uploaded to the remote CAS. This is mutually exclusive with `bypass_local_cache`. If both `skip_upload` and `bypass_local_cache` are set, the server MUST return an InvalidArgument error.
optional unix_mode_mask = 8
The mask to apply to the files being captured. For example, a mask of `0222` will result in contents being captured as read-only. This is only effective when the unix_mode property is captured.
message
local_cas.proto:507A response message for [LocalContentAddressableStorage.CaptureFiles][build.buildgrid.v2.LocalContentAddressableStorage.CaptureFiles].
repeated responses = 1
The responses to the requests.
rpc CaptureTree (, )
local_cas.proto:120Capture a directory tree from the local filesystem. This imports the specified path from the local filesystem into CAS. If a CAS remote is configured, the blobs are uploaded. The `bypass_local_cache` parameter is a hint to indicate whether the blobs shall be uploaded without first storing them in the local cache. The `move_files` parameter is a hint to indicate that files could be moved into the storage. This can make capturing more efficient by avoiding copies when it is known that files will not be needed after they are imported. If a server chooses not to move them, the source files will still exist after this request. The `skip_upload` parameter is a hint to indicate that the files do not need to be uploaded to the remote CAS. This can be useful for local-only workflows where an upload step adds unnecessary latency.
message
local_cas.proto:387A request message for [LocalContentAddressableStorage.CaptureTree][build.buildgrid.v2.LocalContentAddressableStorage.CaptureTree].
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.
string root = 6
The optional root path to restrict capture to a subtree. If specified, `path` will be resolved inside this root. No files outside the root will be captured.
repeated string path = 2
The path(s) in the local filesystem to capture.
bool bypass_local_cache = 3
This is a hint whether the blobs shall be uploaded to the remote CAS without first storing them in the local cache.
repeated string node_properties = 4
The properties of path(s) in the local filesystem to capture.
bool move_files = 5
Hints whether files can be moved into the storage. If enabled, they MUST NOT be modified after issuing this request in order to guarantee consistency.
bazel.remote.execution.v2.Command.OutputDirectoryFormat output_directory_format = 7
The format that the localcas should use to capture the contents of output directories. In case this field is set to a value that is not supported by the localcas, the worker SHOULD interpret this field as TREE_ONLY. The localcas MAY store output directories in formats that are a superset of what was requested (e.g., interpreting DIRECTORY_ONLY as TREE_AND_DIRECTORY).
bool skip_upload = 8
Hints whether files should be uploaded to the remote CAS. This is mutually exclusive with `bypass_local_cache`. If both `skip_upload` and `bypass_local_cache` are set, the server MUST return an InvalidArgument error.
optional unix_mode_mask = 9
The mask to apply to the files and directories being captured. For example, a mask of `0222` will result in contents being captured as read-only. This is only effective when the unix_mode property is captured.
message
local_cas.proto:439A response message for [LocalContentAddressableStorage.CaptureTree][build.buildgrid.v2.LocalContentAddressableStorage.CaptureTree].
repeated responses = 1
The responses to the requests.
rpc FetchMissingBlobs (, )
local_cas.proto:44Fetch blobs from a remote CAS to the local cache. This request is equivalent to ByteStream `Read` or `BatchReadBlobs` requests, storing the downloaded blobs in the local cache. Requested blobs that failed to be downloaded will be listed in the response. Errors: * `INVALID_ARGUMENT`: The client attempted to download more than the server supported limit. Individual requests may return the following error, additionally: * `NOT_FOUND`: The requested blob is not present in the remote CAS.
message
local_cas.proto:204A request message for [LocalContentAddressableStorage.FetchMissingBlobs][build.buildgrid.v2.LocalContentAddressableStorage.FetchMissingBlobs].
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 fetch.
message
local_cas.proto:218A response message for [LocalContentAddressableStorage.FetchMissingBlobs][build.buildgrid.v2.LocalContentAddressableStorage.FetchMissingBlobs].
repeated responses = 1
The responses to the failed requests.
rpc FetchTree (, )
local_cas.proto:73Fetch the entire directory tree rooted at a node from a remote CAS to the local cache. This request is equivalent to `GetTree`, storing the `Directory` objects in the local cache. Optionally, this will also fetch all blobs referenced by the `Directory` objects, equivalent to `FetchMissingBlobs`. If no remote CAS is available, this will check presence of the entire directory tree (and optionally also file blobs) in the local cache. * `NOT_FOUND`: The requested tree is not present in the CAS or incomplete.
message
local_cas.proto:264A request message for [LocalContentAddressableStorage.FetchTree][build.buildgrid.v2.LocalContentAddressableStorage.FetchTree].
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][build.bazel.remote.execution.v2.Directory] message stored in the [ContentAddressableStorage][build.bazel.remote.execution.v2.ContentAddressableStorage].
bool fetch_file_blobs = 3
Whether to fetch blobs of files in the directory tree.
message
local_cas.proto:284A response message for [LocalContentAddressableStorage.FetchTree][build.buildgrid.v2.LocalContentAddressableStorage.FetchTree].
(message has no fields)
Configure sandboxed clients. This returns a string that can be used as instance_name to access this service from clients running in the specified filesystem/mount namespace or chroot environment
message
local_cas.proto:642A request message for [LocalContentAddressableStorage.GetInstanceNameForRemote][build.buildgrid.v2.LocalContentAddressableStorage.GetInstanceNameForNamespace].
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.
string root = 2
The root path of the mount namespace to restrict capture and staging. All paths in requests to the new instance will be resolved inside this root.
message
local_cas.proto:657A response message for [LocalContentAddressableStorage.GetInstanceNameForRemote][build.buildgrid.v2.LocalContentAddressableStorage.GetInstanceNameForNamespace].
string instance_name = 1
Configure remote CAS endpoint. This returns a string that can be used as instance_name to access the specified endpoint in further requests. DEPRECATED: Use `content_addressable_storage` in `GetInstanceNameForRemotes()` instead.
message
local_cas.proto:533A request message for [LocalContentAddressableStorage.GetInstanceNameForRemote][build.buildgrid.v2.LocalContentAddressableStorage.GetInstanceNameForRemote].
string url = 1
The URL for the remote CAS server.
string instance_name = 2
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.
bytes server_cert = 3
PEM-encoded public server certificate for https connections to the remote CAS server.
bytes client_key = 4
PEM-encoded private client key for https with certificate-based client authentication. If this is specified, `client_cert` must be specified as well.
bytes client_cert = 5
PEM-encoded public client certificate for https with certificate-based client authentication. If this is specified, `client_key` must be specified as well.
message
local_cas.proto:561A response message for [LocalContentAddressableStorage.GetInstanceNameForRemote][build.buildgrid.v2.LocalContentAddressableStorage.GetInstanceNameForRemote].
string instance_name = 1
Configure remote endpoints. This returns a string that can be used as instance_name to access the specified endpoints in further requests.
message
local_cas.proto:619A request message for [LocalContentAddressableStorage.GetInstanceNameForRemotes][build.buildgrid.v2.LocalContentAddressableStorage.GetInstanceNameForRemotes].
string instance_name = 3
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 content_addressable_storage = 1
optional remote_asset = 2
optional action_cache = 4
optional execution = 5
message
local_cas.proto:635A response message for [LocalContentAddressableStorage.GetInstanceNameForRemotes][build.buildgrid.v2.LocalContentAddressableStorage.GetInstanceNameForRemotes].
string instance_name = 1
rpc GetLocalDiskUsage (, )
local_cas.proto:164Query total space used by the local cache.
message
local_cas.proto:663A request message for [LocalContentAddressableStorage.GetLocalDiskUsage][build.buildgrid.v2.LocalContentAddressableStorage.GetLocalDiskUsage].
(message has no fields)
message
local_cas.proto:668A response message for [LocalContentAddressableStorage.GetLocalDiskUsage][build.buildgrid.v2.LocalContentAddressableStorage.GetLocalDiskUsage].
int64 size_bytes = 1
Total size used by the local cache, in bytes.
int64 quota_bytes = 2
Disk quota for the local cache, in bytes. A value of 0 means no quota is set.
Retrieves the configuration details for the local CAS server. This RPC allows clients to obtain information such as the hostname, user ID, and storage root of the local CAS server.
message
local_cas.proto:169A request message for [LocalContentAddressableStorage.GetLocalServerDetails][build.buildgrid.v2.LocalContentAddressableStorage.GetLocalServerDetails].
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.
message
local_cas.proto:181A response message for [LocalContentAddressableStorage.GetLocalServerDetails][build.buildgrid.v2.LocalContentAddressableStorage.GetLocalServerDetails].
string hostname = 1
The hostname where the local CAS server is running. This is used to determine if the client is running on the same host as the server. When running on the same host, you may access the storage_root directly.
int64 process_uid = 2
The user ID (UID) which owns the local CAS process. This is used to determine if the client is running as the same user as the server. When running as the same user, hardlinking from the storage_root is dangerous.
string storage_root = 3
The absolute path to the local CAS cache directory. The storage_root contains locally stored blobs for digests in CAS. The local path to a blob has the following format: storage_root/objects/{hash[:2]}/{hash[2:]}
rpc StageTree (stream , stream )
local_cas.proto:101Stage a directory tree in the local filesystem. This makes the specified directory tree temporarily available for local filesystem access. It is implementation-defined whether this uses a userspace filesystem such as FUSE, hardlinking or a full copy. Missing blobs are fetched, if a CAS remote is configured. The staging starts when the server receives the initial request and it is ready to be used on the initial (non-error) response from the server. The server will clean up the staged directory when it either receives an additional request (with all fields unset) or when the stream is closed. The server will send an additional response after cleanup is complete.
message
local_cas.proto:311A request message for [LocalContentAddressableStorage.StageTree][build.buildgrid.v2.LocalContentAddressableStorage.StageTree].
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][build.bazel.remote.execution.v2.Directory] message stored in the [ContentAddressableStorage][build.bazel.remote.execution.v2.ContentAddressableStorage].
string path = 3
The path in the local filesystem where the specified tree should be staged. It must either point to an empty directory or not exist yet. This is optional. If not specified, the server will choose a location. The server may require the path to be on the same filesystem as the local cache to support hardlinking. The path may be a subdirectory of another staged tree. The lifetime of this staged tree will in that case be limited to the lifetime of the parent.
optional access_credentials = 4
The UNIX credentials of the processes that will access the staged tree. This will be used to ensure that the files have the right permissions for access without risking corruption of files in the local cache.
string remote_apis_socket_path = 7
The path, relative to the staging directory, where a server socket should be created for access to the Remote Execution API.
repeated string pre_unstage_commands = 5
The commands to run against the tree before it is cleaned. Each command must be an absolute path to an executable which can be run as `/path/to/command <path-to-stage-dir>`. The working directory of launched commands will be the same as the LocalCAS server process. The server SHOULD maintain an allowlist of commands that can be launched.
StageTreeRequest.StagingMode staging_mode = 6
The staging mode to use for the tree. `INVALID_ARGUMENT` is returned if the server does not support the requested mode.
message
local_cas.proto:380A response message for [LocalContentAddressableStorage.StageTree][build.buildgrid.v2.LocalContentAddressableStorage.StageTree].
string path = 1
The path in the local filesystem where the specified tree has been staged.
rpc UploadMissingBlobs (, )
local_cas.proto:60Upload blobs from the local cache to a remote CAS. This request is equivalent to `FindMissingBlobs` followed by ByteStream `Write` or `BatchUpdateBlobs` requests. Blobs that failed to be uploaded will be listed in the response. Errors: * `INVALID_ARGUMENT`: The client attempted to upload more than the server supported limit. Individual requests may return the following error, additionally: * `NOT_FOUND`: The requested blob is not present in the local cache. * `RESOURCE_EXHAUSTED`: There is insufficient disk quota to store the blob.
message
local_cas.proto:234A request message for [LocalContentAddressableStorage.UploadMissingBlobs][build.buildgrid.v2.LocalContentAddressableStorage.UploadMissingBlobs].
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 fetch.
message
local_cas.proto:248A response message for [LocalContentAddressableStorage.UploadMissingBlobs][build.buildgrid.v2.LocalContentAddressableStorage.UploadMissingBlobs].
repeated responses = 1
The responses to the failed requests.
rpc UploadTree (, )
local_cas.proto:83Upload the entire directory tree from the local cache to a remote CAS. This request is equivalent to `UploadMissingBlobs` for all blobs referenced by the specified tree (recursively). Errors: * `NOT_FOUND`: The requested tree root is not present in the local cache. * `RESOURCE_EXHAUSTED`: There is insufficient disk quota to store the tree.
message
local_cas.proto:289A request message for [LocalContentAddressableStorage.UploadTree][build.buildgrid.v2.LocalContentAddressableStorage.UploadTree].
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][build.bazel.remote.execution.v2.Directory] message stored in the [ContentAddressableStorage][build.bazel.remote.execution.v2.ContentAddressableStorage].
message
local_cas.proto:306A response message for [LocalContentAddressableStorage.UploadTree][build.buildgrid.v2.LocalContentAddressableStorage.UploadTree].
(message has no fields)
message
local_cas.proto:509A response corresponding to a single blob that the client tried to upload.
Used in:
string path = 1
The path to which this response corresponds.
optional digest = 2
The digest of the captured file's content, if successful.
optional status = 3
The result of attempting to capture and upload the file.
bool is_executable = 4
True if the captured file was executable, false otherwise.
optional node_properties = 6
message
local_cas.proto:441A response corresponding to a single blob that the client tried to upload.
Used in:
string path = 1
The path to which this response corresponds.
optional tree_digest = 2
The digest of the captured tree as an encoded [Tree][build.bazel.remote.execution.v2.Tree] proto containing the directory's contents, if successful.
optional status = 3
The result of attempting to capture and upload the tree.
optional root_directory_digest = 4
The digest of the captured directory as an encoded [Tree][build.bazel.remote.execution.v2.Directory] proto containing the directory's contents, if successful.
message
local_cas.proto:220A response corresponding to a single blob that the client tried to download.
Used in:
optional digest = 1
The digest to which this response corresponds.
optional status = 2
The result of attempting to download that blob.
message
local_cas.proto:565Used in:
string url = 1
The URL for the remote server.
string instance_name = 2
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.
bytes server_cert = 3
PEM-encoded public server certificate for https connections to the remote server.
bytes client_key = 4
PEM-encoded private client key for https with certificate-based client authentication. If this is specified, `client_cert` must be specified as well.
bytes client_cert = 5
PEM-encoded public client certificate for https with certificate-based client authentication. If this is specified, `client_key` must be specified as well.
string access_token_path = 7
The path to a token for optional HTTP bearer authentication.
optional access_token_reload_interval = 8
Access token reload interval.
optional keepalive_time = 6
Remote keepalive time. Unset or empty is treated as disabling keepalive.
int64 retry_limit = 9
The maximum number of time a request is retried on this remote A `retry_limit` of 0 indicates that there is no limit and the server can pick a retry_limit
optional retry_delay = 10
The initial recommended retry delay before the first retry, the server might implement a backoff startegy. A `retry_delay` of unset or empty indicates that there is no delay recommended and the server can pick a retry_delay
optional request_timeout = 11
How long to wait for a response from the remote.
bool read_only = 12
If set, don't upload any blobs, action results or assets to the remote.
message
local_cas.proto:337Used in:
int64 uid = 1
int64 gid = 2
Used in:
DEFAULT = 0
The staging mode is not specified. The LocalCAS server will use the default staging mode chosen from its configuration and environment.
FUSE = 1
The tree will be staged using libfuse.
COPY_OR_LINK = 2
The tree will be staged by copying or linking files from the local cache. The exact behavior depends on the filesystem, contents of the tree and the credentials of the client.
message
local_cas.proto:250A response corresponding to a single blob that the client tried to upload.
Used in:
optional digest = 1
The digest to which this response corresponds.
optional status = 2
The result of attempting to upload that blob.