openapi-directory/api/googleapis.com/remotebuildexecution.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://admin-remotebuildexecution.googleapis.com/"}],"info":{"contact":{"name":"Google","url":"https://google.com","x-twitter":"youtube"},"description":"Supplies a Remote Execution API service for tools such as bazel.","license":{"name":"Creative Commons Attribution 3.0","url":"http://creativecommons.org/licenses/by/3.0/"},"termsOfService":"https://developers.google.com/terms/","title":"Remote Build Execution API","version":"v1alpha","x-apiClientRegistration":{"url":"https://console.developers.google.com"},"x-apisguru-categories":["analytics","media"],"x-logo":{"url":"https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png"},"x-origin":[{"format":"openapi","url":"https://admin-remotebuildexecution.googleapis.com/$discovery/rest?version=v1alpha","version":"3.0"}],"x-providerName":"googleapis.com","x-serviceName":"remotebuildexecution"},"externalDocs":{"url":"https://cloud.google.com/remote-build-execution/docs/"},"tags":[{"name":"projects"}],"paths":{"/v1alpha/{name}":{"delete":{"description":"Deletes the specified worker pool. Returns a long running operation, which contains a `google.protobuf.Empty` response on completion. While the long running operation is in progress, any call to `GetWorkerPool` returns a worker pool in state `DELETING`.","operationId":"remotebuildexecution.projects.instances.workerpools.delete","parameters":[{"description":"Name of the worker pool to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"get":{"description":"Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.","operationId":"remotebuildexecution.projects.operations.get","parameters":[{"description":"The name of the operation resource.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"patch":{"description":"Updates an existing worker pool with a specified size and/or configuration. Returns a long running operation, which contains a worker pool on completion. While the long running operation is in progress, any call to `GetWorkerPool` returns a worker pool in state `UPDATING`.","operationId":"remotebuildexecution.projects.instances.workerpools.patch","parameters":[{"description":"WorkerPool resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. name should not be populated when creating a worker pool since it is provided in the `poolId` field.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"Deprecated, use instance.logging_enabled instead. Whether to enable Stackdriver logging for this instance.","in":"query","name":"loggingEnabled","schema":{"type":"boolean"}},{"description":"Deprecated, use instance.Name instead. Name of the instance to update. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.","in":"query","name":"name1","schema":{"type":"string"}},{"description":"The update mask applies to instance. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If an empty update_mask is provided, only the non-default valued field in the worker pool field will be updated. Note that in order to update a field to the default value (zero, false, empty string) an explicit update_mask must be provided.","in":"query","name":"updateMask","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateWorkerPoolRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1alpha/{name}:testNotify":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Sends a test notification to the specified instance. Returns a `google.protobuf.Empty` on success.","operationId":"remotebuildexecution.projects.instances.testNotify","parameters":[{"description":"Name of the instance for which to send a test notification. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleDevtoolsRemotebuildexecutionAdminV1alphaTestNotifyInstanceRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleProtobufEmpty"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1alpha/{parent}/instances":{"get":{"description":"Lists instances in a project.","operationId":"remotebuildexecution.projects.instances.list","parameters":[{"description":"Required. Resource name of the project. Format: `projects/[PROJECT_ID]`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Creates a new instance in the specified region. Returns a long running operation which contains an instance on completion. While the long running operation is in progress, any call to `GetInstance` returns an instance in state `CREATING`.","operationId":"remotebuildexecution.projects.instances.create","parameters":[{"description":"Required. Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1alpha/{parent}/workerpools":{"get":{"description":"Lists worker pools in an instance.","operationId":"remotebuildexecution.projects.instances.workerpools.list","parameters":[{"description":"Resource name of the instance. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Optional. A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. String values are case-insensitive. The comparison operator must be either `:`, `=`, `!=`, `>`, `>=`, `<=` or `<`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. You can also filter on nested fields. To filter on multiple expressions, you can separate expression using `AND` and `OR` operators, using parentheses to specify precedence. If neither operator is specified, `AND` is assumed. Examples: Include only pools with more than 100 reserved workers: `(worker_count > 100) (worker_config.reserved = true)` Include only pools with a certain label or machines of the e2-standard family: `worker_config.labels.key1 : * OR worker_config.machine_type: e2-standard`","in":"query","name":"filter","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Creates a new worker pool with a specified size and configuration. Returns a long running operation which contains a worker pool on completion. While the long running operation is in progress, any call to `GetWorkerPool` returns a worker pool in state `CREATING`.","operationId":"remotebuildexecution.projects.instances.workerpools.create","parameters":[{"description":"Resource name of the instance in which to create the new worker pool. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateWorkerPoolRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}}},"components":{"parameters":{"_.xgafv":{"description":"V1 error format.","in":"query","name":"$.xgafv","schema":{"enum":["1","2"],"type":"string"}},"access_token":{"description":"OAuth access token.","in":"query","name":"access_token","schema":{"type":"string"}},"alt":{"description":"Data format for response.","in":"query","name":"alt","schema":{"enum":["json","media","proto"],"type":"string"}},"callback":{"description":"JSONP","in":"query","name":"callback","schema":{"type":"string"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"type":"string"}},"key":{"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"type":"boolean"}},"quotaUser":{"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","in":"query","name":"quotaUser","schema":{"type":"string"}},"uploadType":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","in":"query","name":"uploadType","schema":{"type":"string"}},"upload_protocol":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","in":"query","name":"upload_protocol","schema":{"type":"string"}}},"schemas":{"BuildBazelRemoteExecutionV2Action":{"description":"An `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, it MAY choose to cache the result in the 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.","properties":{"commandDigest":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2Digest","description":"The digest of the Command to run, which MUST be present in the ContentAddressableStorage."},"doNotCache":{"description":"If true, then the `Action`'s result cannot be cached, and in-flight requests for the same `Action` may not be merged.","type":"boolean"},"inputRootDigest":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2Digest","description":"The digest of the root 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."},"platform":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2Platform","description":"The optional 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. A detailed lexicon for this can be found in the accompanying platform.md. New in version 2.2: clients SHOULD set these platform properties as well as those in the Command. Servers SHOULD prefer those set here."},"salt":{"description":"An optional additional salt value used to place this `Action` into a separate cache namespace from other instances having the same field contents. This salt typically comes from operational configuration specific to sources such as repo and service configuration, and allows disowning an entire set of ActionResults that might have been poisoned by buggy software or tool failures.","format":"byte","type":"string"},"timeout":{"description":"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 only intended to cover the \"execution\" of the specified action and not time in queue nor any overheads before or after execution such as marshalling inputs/outputs. The server SHOULD avoid including time spent the client doesn't have control over, and MAY extend or reduce the timeout to account for delays or speedups that occur during execution itself (e.g., lazily loading data from the Content Addressable Storage, live migration of virtual machines, emulation overhead). The timeout is a part of the 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.","format":"google-duration","type":"string"}},"type":"object"},"BuildBazelRemoteExecutionV2ActionResult":{"description":"An ActionResult represents the result of an Action being run. It is advised that at least one field (for example `ActionResult.execution_metadata.Worker`) have a non-default value, to ensure that the serialized value is non-empty, which can then be used as a basic data sanity check.","properties":{"executionMetadata":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2ExecutedActionMetadata","description":"The details of the execution that originally produced this result."},"exitCode":{"description":"The exit code of the command.","format":"int32","type":"integer"},"outputDirectories":{"description":"The output directories of the action. For each output directory requested in the `output_directories` or `output_paths` 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 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 } ] } } ``` If an output of the same name as listed in `output_files` of the Command was found in `output_directories`, but was not a directory, the server will return a FAILED_PRECONDITION.","items":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2OutputDirectory"},"type":"array"},"outputDirectorySymlinks":{"deprecated":true,"description":"The output directories of the action that are symbolic links to other directories. Those may be links to other output directories, or input directories, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output directory requested in the `output_directories` field of the Action, if the directory existed after the action completed, a single entry will be present either in this field, or in the `output_directories` field, if the directory was not a symbolic link. If an output of the same name was found, but was a symbolic link to a file instead of a directory, the server will return a FAILED_PRECONDITION. If the action does not produce the requested output, 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. DEPRECATED as of v2.1. Servers that wish to be compatible with v2.0 API should still populate this field in addition to `output_symlinks`.","items":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2OutputSymlink"},"type":"array"},"outputFileSymlinks":{"deprecated":true,"description":"The output files of the action that are symbolic links to other files. Those may be links to other output files, or input files, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output file requested in the `output_files` or `output_paths` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or in the `output_files` field, if the file was not a symbolic link. If an output symbolic link of the same name as listed in `output_files` of the Command was found, but its target type was not a regular file, the server will return a FAILED_PRECONDITION. If the action does not produce the requested output, 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. DEPRECATED as of v2.1. Servers that wish to be compatible with v2.0 API should still populate this field in addition to `output_symlinks`.","items":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2OutputSymlink"},"type":"array"},"outputFiles":{"description":"The output files of the action. For each output file requested in the `output_files` or `output_paths` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or the `output_file_symlinks` field if the file was a symbolic link to another file (`output_symlinks` field after v2.1). If an output listed in `output_files` was found, but was a directory rather than a regular file, the server will return a FAILED_PRECONDITION. If the action does not produce the requested output, 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.","items":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2OutputFile"},"type":"array"},"outputSymlinks":{"description":"New in v2.1: this field will only be populated if the command `output_paths` field was used, and not the pre v2.1 `output_files` or `output_directories` fields. The output paths of the action that are symbolic links to other paths. Those may be links to other outputs, or inputs, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. A single entry for each output requested in `output_paths` field of the Action, if the corresponding path existed after the action completed and was a symbolic link. If the action does not produce a requested output, 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.","items":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2OutputSymlink"},"type":"array"},"stderrDigest":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2Digest","description":"The digest for a blob containing the standard error of the action, which can be retrieved from the ContentAddressableStorage."},"stderrRaw":{"description":"The standard error buffer of the action. The server SHOULD NOT inline stderr unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits. Clients SHOULD NOT populate this field when uploading to the cache.","format":"byte","type":"string"},"stdoutDigest":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2Digest","description":"The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage."},"stdoutRaw":{"description":"The standard output buffer of the action. The server SHOULD NOT inline stdout unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits. Clients SHOULD NOT populate this field when uploading to the cache.","format":"byte","type":"string"}},"type":"object"},"BuildBazelRemoteExecutionV2Command":{"description":"A `Command` is the actual command executed by a worker running an Action and specifications of its environment. 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.","properties":{"arguments":{"description":"The arguments to the command. The first argument specifies the command to run, which may be either an absolute path, a path relative to the working directory, or an unqualified path (without path separators) which will be resolved using the operating system's equivalent of the PATH environment variable. Path separators native to the operating system running on the worker SHOULD be used. If the `environment_variables` list contains an entry for the PATH environment variable, it SHOULD be respected. If not, the resolution process is implementation-defined. Changed in v2.3. v2.2 and older require that no PATH lookups are performed, and that relative paths are resolved relative to the input root. This behavior can, however, not be relied upon, as most implementations already followed the rules described above.","items":{"type":"string"},"type":"array"},"environmentVariables":{"description":"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 Commands 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.","items":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2CommandEnvironmentVariable"},"type":"array"},"outputDirectories":{"deprecated":true,"description":"A list of the output directories that the client expects to retrieve from the action. Only the listed directories will be returned (an entire directory structure will be returned as a Tree message digest, see OutputDirectory), as well as files listed in `output_files`. Other files or directories 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). An output directory cannot be duplicated or have the same path as any of the listed output files. An output directory is allowed to be a parent of another output directory. Directories leading up to the output directories (but not the output directories themselves) are created by the worker prior to execution, even if they are not explicitly part of the input root. DEPRECATED since 2.1: Use `output_paths` instead.","items":{"type":"string"},"type":"array"},"outputFiles":{"deprecated":true,"description":"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 or directories 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). An output file cannot be duplicated, be a parent of another output file, or have the same path as any of the listed output directories. Directories leading up to the output files are created by the worker prior to execution, even if they are not explicitly part of the input root. DEPRECATED since v2.1: Use `output_paths` instead.","items":{"type":"string"},"type":"array"},"outputNodeProperties":{"description":"A list of keys for node properties the client expects to retrieve for output files and directories. Keys are either names of string-based NodeProperty or names of fields in NodeProperties. In order to ensure that equivalent `Action`s always hash to the same value, the node properties MUST be lexicographically sorted by name. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. The interpretation of string-based properties is server-dependent. If a property is not recognized by the server, the server will return an `INVALID_ARGUMENT`.","items":{"type":"string"},"type":"array"},"outputPaths":{"description":"A list of the output paths that the client expects to retrieve from the action. Only the listed paths will be returned to the client as output. The type of the output (file or directory) is not specified, and will be determined by the server after action execution. If the resulting path is a file, it will be returned in an OutputFile typed field. If the path is a directory, the entire directory structure will be returned as a Tree message digest, see OutputDirectory Other files or directories 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 deduplicated and sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). Directories leading up to the output paths are created by the worker prior to execution, even if they are not explicitly part of the input root. New in v2.1: this field supersedes the DEPRECATED `output_files` and `output_directories` fields. If `output_paths` is used, `output_files` and `output_directories` will be ignored!","items":{"type":"string"},"type":"array"},"platform":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2Platform","deprecated":true,"description":"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. A detailed lexicon for this can be found in the accompanying platform.md. DEPRECATED as of v2.2: platform properties are now specified directly in the action. See documentation note in the Action for migration."},"workingDirectory":{"description":"The working directory, relative to the input root, for the command to run in. It must be a directory which exists in the input tree. If it is left empty, then the action is run in the input root.","type":"string"}},"type":"object"},"BuildBazelRemoteExecutionV2CommandEnvironmentVariable":{"description":"An `EnvironmentVariable` is one variable to set in the running program's environment.","properties":{"name":{"description":"The variable name.","type":"string"},"value":{"description":"The variable value.","type":"string"}},"type":"object"},"BuildBazelRemoteExecutionV2Digest":{"description":"A 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. 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.","properties":{"hash":{"description":"The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long.","type":"string"},"sizeBytes":{"description":"The size of the blob, in bytes.","format":"int64","type":"string"}},"type":"object"},"BuildBazelRemoteExecutionV2Directory":{"description":"A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` contains its name in the directory, either the digest of its content (either a file blob or a `Directory` proto) or a symlink target, 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). Note that while the API itself is case-sensitive, the environment where the Action is executed may or may not be case-sensitive. That is, it is legal to call the API with a Directory that has both \"Foo\" and \"foo\" as children, but the Action may be rejected by the remote system upon execution. * The files, directories and symlinks 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. * The NodeProperties of files, directories, and symlinks must be sorted in lexicographical order by property name. 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 }, node_properties: [ { \"name\": \"MTime\", \"value\": \"2017-01-15T01:30:15.01Z\" } ] } ], 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 } ] } ```","properties":{"directories":{"description":"The subdirectories in the directory.","items":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2DirectoryNode"},"type":"array"},"files":{"description":"The files in the directory.","items":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2FileNode"},"type":"array"},"nodeProperties":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2NodeProperties"},"symlinks":{"description":"The symlinks in the directory.","items":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2SymlinkNode"},"type":"array"}},"type":"object"},"BuildBazelRemoteExecutionV2DirectoryNode":{"description":"A `DirectoryNode` represents a child of a Directory which is itself a `Directory` and its associated metadata.","properties":{"digest":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2Digest","description":"The digest of the Directory object represented. See Digest for information about how to take the digest of a proto message."},"name":{"description":"The name of the directory.","type":"string"}},"type":"object"},"BuildBazelRemoteExecutionV2ExecuteOperationMetadata":{"description":"Metadata about an ongoing execution, which will be contained in the metadata field of the Operation.","properties":{"actionDigest":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2Digest","description":"The digest of the Action being executed."},"partialExecutionMetadata":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2ExecutedActionMetadata","description":"The client can read this field to view details about the ongoing execution."},"stage":{"description":"The current stage of execution.","enum":["UNKNOWN","CACHE_CHECK","QUEUED","EXECUTING","COMPLETED"],"type":"string"},"stderrStreamName":{"description":"If set, the client can use this resource name with ByteStream.Read to stream the standard error from the endpoint hosting streamed responses.","type":"string"},"stdoutStreamName":{"description":"If set, the client can use this resource name with ByteStream.Read to stream the standard output from the endpoint hosting streamed responses.","type":"string"}},"type":"object"},"BuildBazelRemoteExecutionV2ExecuteResponse":{"description":"The response message for Execution.Execute, which will be contained in the response field of the Operation.","properties":{"cachedResult":{"description":"True if the result was served from cache, false if it was executed.","type":"boolean"},"message":{"description":"Freeform informational message with details on the execution of the action that may be displayed to the user upon failure or when requested explicitly.","type":"string"},"result":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2ActionResult","description":"The result of the action."},"serverLogs":{"additionalProperties":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2LogFile"},"description":"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.","type":"object"},"status":{"$ref":"#/components/schemas/GoogleRpcStatus","description":"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."}},"type":"object"},"BuildBazelRemoteExecutionV2ExecutedActionMetadata":{"description":"ExecutedActionMetadata contains details about a completed execution.","properties":{"auxiliaryMetadata":{"description":"Details that are specific to the kind of worker used. For example, on POSIX-like systems this could contain a message with getrusage(2) statistics.","items":{"additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."},"type":"object"},"type":"array"},"executionCompletedTimestamp":{"description":"When the worker completed executing the action command.","format":"google-datetime","type":"string"},"executionStartTimestamp":{"description":"When the worker started executing the action command.","format":"google-datetime","type":"string"},"inputFetchCompletedTimestamp":{"description":"When the worker finished fetching action inputs.","format":"google-datetime","type":"string"},"inputFetchStartTimestamp":{"description":"When the worker started fetching action inputs.","format":"google-datetime","type":"string"},"outputUploadCompletedTimestamp":{"description":"When the worker finished uploading action outputs.","format":"google-datetime","type":"string"},"outputUploadStartTimestamp":{"description":"When the worker started uploading action outputs.","format":"google-datetime","type":"string"},"queuedTimestamp":{"description":"When was the action added to the queue.","format":"google-datetime","type":"string"},"virtualExecutionDuration":{"description":"New in v2.3: the amount of time the worker spent executing the action command, potentially computed using a worker-specific virtual clock. The virtual execution duration is only intended to cover the \"execution\" of the specified action and not time in queue nor any overheads before or after execution such as marshalling inputs/outputs. The server SHOULD avoid including time spent the client doesn't have control over, and MAY extend or reduce the execution duration to account for delays or speedups that occur during execution itself (e.g., lazily loading data from the Content Addressable Storage, live migration of virtual machines, emulation overhead). The method of timekeeping used to compute the virtual execution duration MUST be consistent with what is used to enforce the Action's `timeout`. There is no relationship between the virtual execution duration and the values of `execution_start_timestamp` and `execution_completed_timestamp`.","format":"google-duration","type":"string"},"worker":{"description":"The name of the worker which ran the execution.","type":"string"},"workerCompletedTimestamp":{"description":"When the worker completed the action, including all stages.","format":"google-datetime","type":"string"},"workerStartTimestamp":{"description":"When the worker received the action.","format":"google-datetime","type":"string"}},"type":"object"},"BuildBazelRemoteExecutionV2FileNode":{"description":"A `FileNode` represents a single file and associated metadata.","properties":{"digest":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2Digest","description":"The digest of the file's content."},"isExecutable":{"description":"True if file is executable, false otherwise.","type":"boolean"},"name":{"description":"The name of the file.","type":"string"},"nodeProperties":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2NodeProperties"}},"type":"object"},"BuildBazelRemoteExecutionV2LogFile":{"description":"A `LogFile` is a log stored in the CAS.","properties":{"digest":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2Digest","description":"The digest of the log contents."},"humanReadable":{"description":"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.","type":"boolean"}},"type":"object"},"BuildBazelRemoteExecutionV2NodeProperties":{"description":"Node properties for FileNodes, DirectoryNodes, and SymlinkNodes. The server is responsible for specifying the properties that it accepts.","properties":{"mtime":{"description":"The file's last modification timestamp.","format":"google-datetime","type":"string"},"properties":{"description":"A list of string-based NodeProperties.","items":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2NodeProperty"},"type":"array"},"unixMode":{"description":"The UNIX file mode, e.g., 0755.","format":"uint32","type":"integer"}},"type":"object"},"BuildBazelRemoteExecutionV2NodeProperty":{"description":"A single property for FileNodes, DirectoryNodes, and SymlinkNodes. The server is responsible for specifying the property `name`s that it accepts. If permitted by the server, the same `name` may occur multiple times.","properties":{"name":{"description":"The property name.","type":"string"},"value":{"description":"The property value.","type":"string"}},"type":"object"},"BuildBazelRemoteExecutionV2OutputDirectory":{"description":"An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file.","properties":{"isTopologicallySorted":{"description":"If set, consumers MAY make the following assumptions about the directories contained in the the Tree, so that it may be instantiated on a local file system by scanning through it sequentially: - All directories with the same binary representation are stored exactly once. - All directories, apart from the root directory, are referenced by at least one parent directory. - Directories are stored in topological order, with parents being stored before the child. The root directory is thus the first to be stored. Additionally, the Tree MUST be encoded as a stream of records, where each record has the following format: - A tag byte, having one of the following two values: - (1 << 3) | 2 == 0x0a: First record (the root directory). - (2 << 3) | 2 == 0x12: Any subsequent records (child directories). - The size of the directory, encoded as a base 128 varint. - The contents of the directory, encoded as a binary serialized Protobuf message. This encoding is a subset of the Protobuf wire format of the Tree message. As it is only permitted to store data associated with field numbers 1 and 2, the tag MUST be encoded as a single byte. More details on the Protobuf wire format can be found here: https://developers.google.com/protocol-buffers/docs/encoding It is recommended that implementations using this feature construct Tree objects manually using the specification given above, as opposed to using a Protobuf library to marshal a full Tree message. As individual Directory messages already need to be marshaled to compute their digests, constructing the Tree object manually avoids redundant marshaling.","type":"boolean"},"path":{"description":"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.","type":"string"},"treeDigest":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2Digest","description":"The digest of the encoded Tree proto containing the directory's contents."}},"type":"object"},"BuildBazelRemoteExecutionV2OutputFile":{"description":"An `OutputFile` is similar to a FileNode, but it is used as an output in an `ActionResult`. It allows a full file path rather than only a name.","properties":{"contents":{"description":"The contents of the file if inlining was requested. The server SHOULD NOT inline file contents unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits. Clients SHOULD NOT populate this field when uploading to the cache.","format":"byte","type":"string"},"digest":{"$ref":"#/components/schemas/BuildBazelRemoteExecutionV2Digest","description":"The digest of the file's content."},"isExecutable":{"description":"True