{ "batchPath": "batch", "ownerDomain": "google.com", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "mtlsRootUrl": "https://admin-remotebuildexecution.mtls.googleapis.com/", "discoveryVersion": "v1", "ownerName": "Google", "title": "Remote Build Execution API", "rootUrl": "https://admin-remotebuildexecution.googleapis.com/", "documentationLink": "https://cloud.google.com/remote-build-execution/docs/", "basePath": "", "revision": "20260602", "protocol": "rest", "canonicalName": "Remote Build Execution", "name": "remotebuildexecution", "servicePath": "", "kind": "discovery#restDescription", "parameters": { "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "type": "string", "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.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "type": "string", "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.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" } }, "version_module": true, "resources": { "projects": { "resources": { "operations": { "methods": { "get": { "id": "remotebuildexecution.projects.operations.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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." } } }, "instances": { "methods": { "create": { "id": "remotebuildexecution.projects.instances.create", "path": "v1alpha/{+parent}/instances", "flatPath": "v1alpha/projects/{projectsId}/instances", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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`." }, "get": { "id": "remotebuildexecution.projects.instances.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/instances/{instancesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Name of the instance to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.", "pattern": "^projects/[^/]+/instances/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Returns the specified instance." }, "delete": { "id": "remotebuildexecution.projects.instances.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/instances/{instancesId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. Name of the instance to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.", "pattern": "^projects/[^/]+/instances/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes the specified instance. Returns a long running operation which contains a `google.protobuf.Empty` response on completion. Deleting an instance with worker pools in it will delete these worker pools." }, "list": { "id": "remotebuildexecution.projects.instances.list", "path": "v1alpha/{+parent}/instances", "flatPath": "v1alpha/projects/{projectsId}/instances", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Resource name of the project. Format: `projects/[PROJECT_ID]`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists instances in a project." }, "testNotify": { "id": "remotebuildexecution.projects.instances.testNotify", "path": "v1alpha/{+name}:testNotify", "flatPath": "v1alpha/projects/{projectsId}/instances/{instancesId}:testNotify", "httpMethod": "POST", "parameters": { "name": { "description": "Name of the instance for which to send a test notification. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.", "pattern": "^projects/[^/]+/instances/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaTestNotifyInstanceRequest" }, "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sends a test notification to the specified instance. Returns a `google.protobuf.Empty` on success." }, "patch": { "id": "remotebuildexecution.projects.instances.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/instances/{instancesId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field.", "pattern": "^projects/[^/]+/instances/[^/]+$", "location": "path", "required": true, "type": "string" }, "name1": { "description": "Optional. Deprecated: Use instance.Name instead. Name of the instance to update. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.", "location": "query", "deprecated": true, "type": "string" }, "updateMask": { "description": "Optional. 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.", "location": "query", "type": "string", "format": "google-fieldmask" }, "loggingEnabled": { "description": "Optional. Deprecated: Use instance.logging_enabled instead. Whether to enable Stackdriver logging for this instance.", "location": "query", "deprecated": true, "type": "boolean" }, "validateOnly": { "description": "Optional. If true, the request will be validated but not executed.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the specified instance. Returns a long running operation which contains the updated instance in the response on completion." }, "createBackendIAMBinding": { "id": "remotebuildexecution.projects.instances.createBackendIAMBinding", "path": "v1alpha/{+parent}:createBackendIAMBinding", "flatPath": "v1alpha/projects/{projectsId}/instances/{instancesId}:createBackendIAMBinding", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Name of the instance to create a backend project IAM binding for. Format: projects/[PROJECT_ID]/instances/[INSTANCE_ID]", "pattern": "^projects/[^/]+/instances/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateBackendIAMBindingRequest" }, "response": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateBackendIAMBindingResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates an IAM binding on the backend project. Yields a FAILED_PRECONDITION error if this instance is not allowlisted for the requested binding. Backend IAM bindings are only applicable for specific RBE instances. Please reach out to the RBE team for more details. Yields OK if the exact binding between role and principal already exists. Binding the same role to multiple principals is permitted." }, "deleteBackendIAMBinding": { "id": "remotebuildexecution.projects.instances.deleteBackendIAMBinding", "path": "v1alpha/{+parent}:deleteBackendIAMBinding", "flatPath": "v1alpha/projects/{projectsId}/instances/{instancesId}:deleteBackendIAMBinding", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Name of the instance to delete a backend project IAM binding for. Format: projects/[PROJECT_ID]/instances/[INSTANCE_ID]", "pattern": "^projects/[^/]+/instances/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteBackendIAMBindingRequest" }, "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes an IAM binding on the backend project. Yields a FAILED_PRECONDITION error if the parent instance is not allowlisted for at least one of the ENABLE_BE_IAM_BINDING_* entries. Yields a NOT_FOUND error if the binding does not exist." }, "createGuitar": { "id": "remotebuildexecution.projects.instances.createGuitar", "path": "v1alpha/{+parent}/instances:createGuitar", "flatPath": "v1alpha/projects/{projectsId}/instances:createGuitar", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateGuitarInstanceRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new instance of type Guitar in the specified region." }, "createAndroidCI": { "id": "remotebuildexecution.projects.instances.createAndroidCI", "path": "v1alpha/{+parent}/instances:CreateAndroidCI", "flatPath": "v1alpha/projects/{projectsId}/instances:CreateAndroidCI", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateAndroidCIInstanceRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new instance of type Android CI in the specified region." }, "createKokoro": { "id": "remotebuildexecution.projects.instances.createKokoro", "path": "v1alpha/{+parent}/instances:CreateKokoro", "flatPath": "v1alpha/projects/{projectsId}/instances:CreateKokoro", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateKokoroInstanceRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new instance of type Kokoro in the specified region." }, "createTBI": { "id": "remotebuildexecution.projects.instances.createTBI", "path": "v1alpha/{+parent}/instances:CreateTBI", "flatPath": "v1alpha/projects/{projectsId}/instances:CreateTBI", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateTbiInstanceRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new instance of type TBI in the specified region." } }, "resources": { "workerpools": { "methods": { "create": { "id": "remotebuildexecution.projects.instances.workerpools.create", "path": "v1alpha/{+parent}/workerpools", "flatPath": "v1alpha/projects/{projectsId}/instances/{instancesId}/workerpools", "httpMethod": "POST", "parameters": { "parent": { "description": "Resource name of the instance in which to create the new worker pool. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.", "pattern": "^projects/[^/]+/instances/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateWorkerPoolRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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`." }, "patch": { "id": "remotebuildexecution.projects.instances.workerpools.patch", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/instances/{instancesId}/workerpools/{workerpoolsId}", "httpMethod": "PATCH", "parameters": { "name": { "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.", "pattern": "^projects/[^/]+/instances/[^/]+/workerpools/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateWorkerPoolRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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`." }, "get": { "id": "remotebuildexecution.projects.instances.workerpools.get", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/instances/{instancesId}/workerpools/{workerpoolsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Name of the worker pool to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`.", "pattern": "^projects/[^/]+/instances/[^/]+/workerpools/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Returns the specified worker pool." }, "delete": { "id": "remotebuildexecution.projects.instances.workerpools.delete", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/instances/{instancesId}/workerpools/{workerpoolsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Name of the worker pool to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`.", "pattern": "^projects/[^/]+/instances/[^/]+/workerpools/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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`." }, "list": { "id": "remotebuildexecution.projects.instances.workerpools.list", "path": "v1alpha/{+parent}/workerpools", "flatPath": "v1alpha/projects/{projectsId}/instances/{instancesId}/workerpools", "httpMethod": "GET", "parameters": { "parent": { "description": "Resource name of the instance. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.", "pattern": "^projects/[^/]+/instances/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "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 `:`, `=`, `!=`, `\u003e`, `\u003e=`, `\u003c=` or `\u003c`. 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 \u003e 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`", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists worker pools in an instance." } } } } } } } }, "baseUrl": "https://admin-remotebuildexecution.googleapis.com/", "description": "Supplies a Remote Execution API service for tools such as bazel.", "version": "v1alpha", "fullyEncodeReservedExpansion": true, "schemas": { "GoogleLongrunningOperation": { "id": "GoogleLongrunningOperation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "metadata": { "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus" }, "response": { "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "GoogleRpcStatus": { "id": "GoogleRpcStatus", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest", "description": "The request used for `CreateInstance`.", "type": "object", "properties": { "parent": { "description": "Required. Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`.", "type": "string" }, "instanceId": { "description": "Required. ID of the created instance. A valid `instance_id` must: - Be 6-50 characters long - Contain only lowercase letters, digits, hyphens and underscores - Start with a lowercase letter - End with a lowercase letter or a digit", "type": "string" }, "instance": { "description": "Required. Specifies the instance to create. The name in the instance, if specified in the instance, is ignored.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance", "description": "Instance conceptually encapsulates all Remote Build Execution resources for remote builds. An instance consists of storage and compute resources (for example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for running remote builds. All Remote Build Execution API calls are scoped to an instance.", "type": "object", "properties": { "name": { "description": "Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field.", "readOnly": true, "type": "string" }, "location": { "description": "The location is a GCP region. Currently only `us-central1` is supported.", "type": "string" }, "state": { "description": "Output only. State of the instance.", "readOnly": true, "type": "string", "enumDescriptions": [ "Not a valid state, but the default value of the enum.", "The instance is in state `CREATING` once `CreateInstance` is called and before the instance is ready for use.", "The instance is in state `RUNNING` when it is ready for use.", "An `INACTIVE` instance indicates that there is a problem that needs to be fixed. Such instances cannot be used for execution and instances that remain in this state for a significant period of time will be removed permanently." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "RUNNING", "INACTIVE" ] }, "loggingEnabled": { "description": "Output only. Whether stack driver logging is enabled for the instance.", "readOnly": true, "type": "boolean" }, "featurePolicy": { "description": "The policy to define whether or not RBE features can be used or how they can be used.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy" }, "schedulerNotificationConfig": { "description": "The instance's configuration for scheduler notifications. Absence implies that this feature is not enabled for this instance.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaSchedulerNotificationConfig" }, "backendProperties": { "description": "Output only. Describes the instance's backend project configuration. Currently, this includes the list of user-managed IAM bindings applied to the backend project, which will always be empty for instances not in one of the ENABLE_BE_IAM_BINDING_* feature allowlists.", "readOnly": true, "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaBackendProperties" }, "casRelations": { "description": "Specify parent or child instances of `this` instance. Configurations will be rejected if: -- If `this` instance is not allowlisted for `ENABLE_DATA_READS_FROM_PARENT` and this list specifies parent instances. -- If `this` instance is not allowlisted for `ENABLE_DATA_READS_BY_CHILDREN` and this list specifies child instances. -- If both parent and child instances are specified. -- If instance has more than allowed number of parent or child instances.", "type": "array", "items": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaRelationship" } }, "storageSettings": { "description": "User-specified storage settings for this instance.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaStorageSettings" }, "zoneDrains": { "description": "Optional. The list of zones that should be drained (no new tasks should be assigned to all or part of the workers in these).", "type": "array", "items": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaZoneDrain" } }, "bindings": { "description": "Optional. The list of IAM bindings that should be applied to this instance.", "type": "array", "items": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaIAMBinding" } }, "githubEnterpriseAccess": { "description": "Optional. GitHub Enterprise access configuration for the instance.", "type": "string", "enumDescriptions": [ "Default value; interpreted as DISABLED.", "Instance without GitHub Enterprise access.", "Instance with GitHub Enterprise access. Enabling this allows the RBE worker to connect to Google's GitHub Enterprise Server (GHES) instance via a Private Service Connect (PSC) endpoint. Currently, only GCB is intended to use this mode." ], "enum": [ "GITHUB_ENTERPRISE_ACCESS_UNSPECIFIED", "GITHUB_ENTERPRISE_ACCESS_DISABLED", "GITHUB_ENTERPRISE_ACCESS_ENABLED" ] } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy", "description": "FeaturePolicy defines features allowed to be used on RBE instances, as well as instance-wide behavior changes that take effect without opt-in or opt-out at usage time.", "type": "object", "properties": { "dockerAddCapabilities": { "description": "Whether dockerAddCapabilities can be used or what capabilities are allowed.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature" }, "dockerNetwork": { "description": "Whether dockerNetwork can be used or what network modes are allowed. E.g. one may allow `off` value only via `allowed_values`.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature" }, "dockerPrivileged": { "description": "Whether dockerPrivileged can be used.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature" }, "dockerRunAsRoot": { "description": "Whether dockerRunAsRoot can be used.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature" }, "dockerRuntime": { "description": "Whether dockerRuntime is allowed to be set or what runtimes are allowed. Note linux_isolation takes precedence, and if set, docker_runtime values may be rejected if they are incompatible with the selected isolation.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature" }, "dockerSiblingContainers": { "description": "Whether dockerSiblingContainers can be used.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature" }, "containerImageSources": { "description": "Which container image sources are allowed. Currently only RBE-supported registry (gcr.io) is allowed. One can allow all repositories under a project or one specific repository only. E.g. container_image_sources { policy: RESTRICTED allowed_values: [ \"gcr.io/project-foo\", \"gcr.io/project-bar/repo-baz\", ] } will allow any repositories under \"gcr.io/project-foo\" plus the repository \"gcr.io/project-bar/repo-baz\". Default (UNSPECIFIED) is equivalent to any source is allowed.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature" }, "linuxIsolation": { "description": "linux_isolation allows overriding the docker runtime used for containers started on Linux.", "type": "string", "enumDescriptions": [ "Default value. Will be using Linux default runtime.", "Use gVisor runsc runtime.", "Use standard Linux runtime. This has the same behaviour as unspecified, but it can be used to revert back from gVisor." ], "enum": [ "LINUX_ISOLATION_UNSPECIFIED", "GVISOR", "OFF" ] }, "dockerChrootPath": { "description": "Whether dockerChrootPath can be used.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature" }, "dockerRunAsContainerProvidedUser": { "description": "Whether dockerRunAsContainerProvidedUser can be used.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature" }, "vmVerification": { "description": "Whether to verify CreateBotSession and UpdateBotSession from the bot.", "type": "string", "enumDescriptions": [ "Default value. Same as GCP_TOKEN.", "Verify the VM token and the nonce associated with the VM.", "Don't verify VM token and nonce." ], "enum": [ "VM_VERIFICATION_UNSPECIFIED", "VM_VERIFICATION_GCP_TOKEN", "VM_VERIFICATION_OFF" ] }, "linuxExecution": { "description": "Defines how Linux actions are allowed to execute. DO NOT USE: Experimental / unlaunched feature.", "type": "string", "enumDescriptions": [ "Default value, if not explicitly set. Equivalent to FORBIDDEN.", "Linux actions and worker pools are forbidden.", "No restrictions on execution of Linux actions.", "Linux actions will be hardened using gVisor. Actions that specify a configuration incompatible with gVisor hardening will be rejected. Example per-action platform properties that are incompatible with gVisor hardening are: 1. dockerRuntime is set to a value other than \"runsc\". Leaving dockerRuntime unspecified *is* compatible with gVisor. 2. dockerPrivileged is set to \"true\". etc.", "Linux actions will be hardened using gVisor if their configuration is compatible with gVisor hardening. Otherwise, the action will be terminal, i.e., the worker VM that runs the action will be terminated after the action finishes." ], "enum": [ "LINUX_EXECUTION_UNSPECIFIED", "LINUX_EXECUTION_FORBIDDEN", "LINUX_EXECUTION_UNRESTRICTED", "LINUX_EXECUTION_HARDENED_GVISOR", "LINUX_EXECUTION_HARDENED_GVISOR_OR_TERMINAL" ] }, "windowsExecution": { "description": "Defines how Windows actions are allowed to execute. DO NOT USE: Experimental / unlaunched feature.", "type": "string", "enumDescriptions": [ "Default value, if not explicitly set. Equivalent to FORBIDDEN.", "Windows actions and worker pools are forbidden.", "No restrictions on execution of Windows actions.", "Windows actions will always result in the worker VM being terminated after the action completes." ], "enum": [ "WINDOWS_EXECUTION_UNSPECIFIED", "WINDOWS_EXECUTION_FORBIDDEN", "WINDOWS_EXECUTION_UNRESTRICTED", "WINDOWS_EXECUTION_TERMINAL" ] }, "macExecution": { "description": "Defines how Windows actions are allowed to execute. DO NOT USE: Experimental / unlaunched feature.", "type": "string", "enumDescriptions": [ "Default value, if not explicitly set. Equivalent to FORBIDDEN.", "Mac actions and worker pools are forbidden.", "No restrictions on execution of Mac actions.", "Mac actions will always result in the worker VM being terminated after the action completes." ], "enum": [ "MAC_EXECUTION_UNSPECIFIED", "MAC_EXECUTION_FORBIDDEN", "MAC_EXECUTION_UNRESTRICTED", "MAC_EXECUTION_TERMINAL" ] }, "actionIsolation": { "description": "Defines the isolation policy for actions on this instance. DO NOT USE: Experimental / unlaunched feature.", "type": "string", "enumDescriptions": [ "Default value, if not explicitly set. Equivalent to OFF.", "Disables enforcing feature policies that guarantee action isolation.", "Enforces setting feature policies that ensures actions within the RBE Instance are isolated from each other in a way deemed sufficient by ISE reviewers." ], "enum": [ "ACTION_ISOLATION_UNSPECIFIED", "ACTION_ISOLATION_OFF", "ACTION_ISOLATION_ENFORCED" ] }, "actionHermeticity": { "description": "Defines the hermeticity policy for actions on this instance. DO NOT USE: Experimental / unlaunched feature.", "type": "string", "enumDescriptions": [ "Default value, if not explicitly set. Equivalent to OFF.", "Disables enforcing feature policies that guarantee action hermeticity.", "Enforces hermeticity of actions by requiring feature policies to be set that prevent actions from gaining network access. The enforcement mechanism has been reviewed by ISE.", "Requires feature policies to be set that provide best effort hermeticity for actions. Best effort hermeticity means network access will be disabled and not trivial to bypass. However, a determined and malicious action may still find a way to gain network access." ], "enum": [ "ACTION_HERMETICITY_UNSPECIFIED", "ACTION_HERMETICITY_OFF", "ACTION_HERMETICITY_ENFORCED", "ACTION_HERMETICITY_BEST_EFFORT" ] }, "dockerUlimits": { "description": "Whether dockerUlimits are allowed to be set.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature" }, "networkAccess": { "description": "Optional. Defines the network access policy for actions on this instance. DO NOT USE: Experimental / unlaunched feature.", "type": "string", "enumDescriptions": [ "Default value, if not explicitly set. Equivalent to ALLOWED.", "Disables enforcing feature policies related to network access.", "Requires feature policies to be set that guarantee network access restrctions. Enforced means that network access will be limited and certain features will be disabled to prevent bypassing the filter. However, a determined and malicious actor may still find a way to gain full network access." ], "enum": [ "NETWORK_ACCESS_UNSPECIFIED", "NETWORK_ACCESS_ALLOWED", "NETWORK_ACCESS_ENFORCED" ] } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature", "description": "Defines whether a feature can be used or what values are accepted.", "type": "object", "properties": { "policy": { "description": "The policy of the feature.", "type": "string", "enumDescriptions": [ "Default value, if not explicitly set. Equivalent to FORBIDDEN, unless otherwise documented on a specific Feature.", "Feature is explicitly allowed.", "Feature is forbidden. Requests attempting to leverage it will get an FailedPrecondition error, with a message like: \"Feature forbidden by FeaturePolicy: Feature on instance \"", "Only the values specified in the `allowed_values` are allowed." ], "enum": [ "POLICY_UNSPECIFIED", "ALLOWED", "FORBIDDEN", "RESTRICTED" ] }, "allowedValues": { "description": "A list of acceptable values. Only effective when the policy is `RESTRICTED`.", "type": "array", "items": { "type": "string" } } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaSchedulerNotificationConfig": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaSchedulerNotificationConfig", "description": "Defines configurations for an instance's scheduler notifications, where a target Pub/Sub topic will be notified whenever a task (e.g. an action or reservation) completes on this instance.", "type": "object", "properties": { "topic": { "description": "The Pub/Sub topic resource name to issue notifications to. Note that the topic does not need to be owned by the same project as this instance. Format: projects//topics/", "type": "string" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaBackendProperties": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaBackendProperties", "description": "Describes backend project configuration. As of 2024Q2, this consists of user- managed IAM bindings established for this instance as well as the identity of the backend project.", "type": "object", "properties": { "backendProjectNumber": { "description": "Output only. The backend project number is not normally exposed to the user but is required by the user for these IAM role bindings to be useful. For example, a role that grants SSH access to worker machines in the backend project is useless if those machines cannot then be discovered.", "readOnly": true, "type": "string" }, "bindings": { "description": "Output only. List of the desired BE project bindings.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaBackendIAMBinding" } } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaBackendIAMBinding": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaBackendIAMBinding", "description": "A representation of an individual backend IAM binding.", "type": "object", "properties": { "principal": { "description": "Required. The IAM principal (i.e. twosync or twosync-src group) this binding applies to. This should be prefixed with `group:`. Example format: group:alphasource-foundry-team-policy@twosync.google.com", "type": "string" }, "role": { "description": "Required. The RBE-managed IAM role this binding applies to. The set of eligible roles depends on which instance allowlist(s) the parent instance is a member of, specifically with regards to the ENABLE_BE_IAM_BINDING_* entries. Format: roles/", "type": "string" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaRelationship": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaRelationship", "description": "Defines the relationship with another RBE instance.", "type": "object", "properties": { "instance": { "description": "Instance resource name (e.g. `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`) of an instance which is either a parent or child of another RBE instance.", "type": "string" }, "relation": { "description": "Specify the relationship between `instance` and the RBE instance it is related to.", "type": "string", "enumDescriptions": [ "Default value but not a valid value; it is an error to set this value.", "`instance` is a parent of another RBE instance.", "`instance` is a child of another RBE instance." ], "enum": [ "RELATION_UNSPECIFIED", "RELATION_CAS_PARENT", "RELATION_CAS_CHILD" ] }, "status": { "description": "Output only. The validation result of this relationship. Possible status codes are: - `OK`: a valid relationship - `FAILED_PRECONDITION`: missing allowlist or misconfigured instance (Note that we don't want to return `NOT_FOUND` which leaks information about whether or not a project exists)", "readOnly": true, "$ref": "GoogleRpcStatus" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaStorageSettings": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaStorageSettings", "description": "Describes the storage settings for an instance. This consists of user- specified TTL values for CAS and ActionResult entries.", "type": "object", "properties": { "casTtl": { "description": "Defines how long after a blob was uploaded or last accessed before it is eligible for garbage collection (TTL countdowns are reset upon access). RBE may remove it from the instance's CAS at any time after this period has elapsed.", "type": "string", "format": "google-duration" }, "actionResultTtl": { "description": "Defines how long after a cached execution result was uploaded or accessed (due to a cache hit) before it is eligible for garbage collection (TTL countdowns are reset upon access). RBE may remove it from the action cache at any time after this period has elapsed. Note that the action cache only concerns when an incoming execution to RBE results in a cache hit. Input and output artifacts of the action are stored in the RBE CAS.", "type": "string", "format": "google-duration" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaZoneDrain": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaZoneDrain", "description": "ZoneDrain indicates a zone that should be drained (no new tasks should be assigned to all or part of the workers in it).", "type": "object", "properties": { "zone": { "description": "Required. The zone to drain.", "type": "string" }, "percent": { "description": "Optional. The percentage of workers in the zone to drain, from 0 (no workers drained) to 100 (all workers drained).", "type": "integer", "format": "int32" }, "zoneType": { "description": "Optional. Type of zone for validation purposes.", "type": "string", "enumDescriptions": [ "When unspecified, defaults to GCE zone type.", "Validate as GCE zone." ], "enum": [ "ZONE_TYPE_UNSPECIFIED", "ZONE_TYPE_GCE" ] } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaIAMBinding": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaIAMBinding", "description": "Represents an IAM binding.", "type": "object", "properties": { "principal": { "description": "Required. The IAM principal this binding applies to.", "type": "string" }, "role": { "description": "Required. The IAM role this binding applies to. Format: `roles/`", "type": "string" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesResponse": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesResponse", "description": "The response used for `ListInstances`.", "type": "object", "properties": { "instances": { "description": "The list of instances in a given project.", "type": "array", "items": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance" } }, "unreachable": { "description": "Unreachable regions.", "type": "array", "items": { "type": "string" } } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaTestNotifyInstanceRequest": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaTestNotifyInstanceRequest", "description": "The request used for `TestNotifyInstance`.", "type": "object", "properties": {} }, "GoogleProtobufEmpty": { "id": "GoogleProtobufEmpty", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object", "properties": {} }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateBackendIAMBindingRequest": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateBackendIAMBindingRequest", "description": "The request used for `CreateBackendIAMBinding`.", "type": "object", "properties": { "backendIamBinding": { "description": "Required. The backend IAM binding to create.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaBackendIAMBinding" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateBackendIAMBindingResponse": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateBackendIAMBindingResponse", "description": "The response used for `CreateBackendIAMBinding`.", "type": "object", "properties": { "backendProperties": { "description": "The backend properties of the instance, which contains the list of backend IAM bindings, after creation of the most recent binding.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaBackendProperties" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteBackendIAMBindingRequest": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteBackendIAMBindingRequest", "description": "The request used for `DeleteBackendIAMBinding`.", "type": "object", "properties": { "backendIamBinding": { "description": "Required. The backend IAM binding to delete.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaBackendIAMBinding" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateGuitarInstanceRequest": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateGuitarInstanceRequest", "description": "The request used for `CreateGuitarInstance`.", "type": "object", "properties": { "parent": { "description": "Required. Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`.", "type": "string" }, "instanceId": { "description": "Required. ID of the created instance. A valid `instance_id` must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit.", "type": "string" }, "instance": { "description": "Required. Specifies the instance to create. The name in the instance, if specified in the instance, is ignored.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateAndroidCIInstanceRequest": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateAndroidCIInstanceRequest", "description": "The request used for `CreateAndroidCIInstance`.", "type": "object", "properties": { "parent": { "description": "Required. Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`.", "type": "string" }, "instanceId": { "description": "Required. ID of the created instance. A valid `instance_id` must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit.", "type": "string" }, "instance": { "description": "Required. Specifies the instance to create. The name in the instance, if specified in the instance, is ignored.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance" }, "vmServiceAccount": { "description": "Optional. Service Account is the service account that will be used to run the VMs.", "type": "string" }, "macServiceAccount": { "description": "Optional. Mac Service Account is the service account that will be used to run Mac VMs.", "type": "string" }, "billingProjectManagerGroup": { "description": "Optional. Billing Project Manager Group used for changing the billing account of the backend project as we will be bypassing the BE chargeback.", "type": "string" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateKokoroInstanceRequest": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateKokoroInstanceRequest", "description": "The request used for `CreateKokoroInstance`.", "type": "object", "properties": { "parent": { "description": "Required. Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`.", "type": "string" }, "instanceId": { "description": "Required. ID of the created instance. A valid `instance_id` must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit.", "type": "string" }, "instance": { "description": "Required. Specifies the instance to create. The name in the instance, if specified in the instance, is ignored.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance" }, "immutableMetapolicy": { "description": "Enforces meta policy immutability if set to true. This field is required. We use 'optional' here to catch (and error on) the case where this field is unset.", "type": "boolean" }, "adminOpsRestrictions": { "description": "Optional. If AdminOpsRestrictions is ADMIN_OPS_RESTRICTIONS_RESTRICTED then only predefined safe fields are allowed to set through internal APIs through toolproxy. AdminOpsRestrictions can be set to ADMIN_OPS_RESTRICTIONS_RESTRICTED only if ACTION_ISOLATION is enforced.", "type": "string", "enumDescriptions": [ "Default value; interpreted as RESTRICTIONS_ALLOWED.", "Admin operations are allowed normally.", "Admin operations are restricted to known safe operations that do not affect build integrity." ], "enum": [ "RESTRICTIONS_UNSPECIFIED", "RESTRICTIONS_ALLOWED", "RESTRICTIONS_RESTRICTED" ] }, "tcaRestrictions": { "description": "Optional. If tca_restrictions is ENABLED then the instance will have restrictions needed for building Trusted Core Access (TCA) compliant builds. DO NOT USE: In-Development feature.", "type": "string", "enumDescriptions": [ "TCA restrictions are not specified, defaulting to RESTRICTIONS_DISABLED.", "TCA restrictions are disabled for the instance.", "V1 version of TCA restrictions are enabled for the instance. These include: 1. ActionIsolation to be ENFORCED. 2. ImmutableMetaPolicy to be true. 3. AdminOpsRestrictions to be RESTRICTED. 4. Using Shielded, Confidential and Software Trusted VMs as RBE workers, which use custom RBE TCA COS VM images and go through TPM attestation verification for various boot parameters. 5. Inputs and outputs of the actions on these VMs requires TPM attestation verification." ], "enum": [ "RESTRICTIONS_UNSPECIFIED", "RESTRICTIONS_DISABLED", "RESTRICTIONS_ENABLED_V1" ] }, "validateOnly": { "description": "Optional. If true, the request will be validated but not executed.", "type": "boolean" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateTbiInstanceRequest": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateTbiInstanceRequest", "description": "The request used for `CreateTbiInstance`.", "type": "object", "properties": { "instanceId": { "description": "Required. ID of the created instance. A valid `instance_id` must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit.", "type": "string" }, "instance": { "description": "Required. Specifies the instance to create. The name in the instance, if specified in the instance, is ignored.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance" }, "immutableMetapolicy": { "description": "Required. Enforces meta policy immutability if set to true. This field is required. We use 'optional' here to track field presence so that we may catch (and error on) the case where this field is unset.", "type": "boolean" }, "adminOpsRestrictions": { "description": "Optional. If AdminOpsRestrictions is ADMIN_OPS_RESTRICTIONS_RESTRICTED then only predefined safe fields are allowed to set through internal APIs through toolproxy. AdminOpsRestrictions can be set to ADMIN_OPS_RESTRICTIONS_RESTRICTED only if ACTION_ISOLATION is enforced.", "type": "string", "enumDescriptions": [ "Default value; interpreted as RESTRICTIONS_ALLOWED.", "Admin operations are allowed normally.", "Admin operations are restricted to known safe operations that do not affect build integrity." ], "enum": [ "RESTRICTIONS_UNSPECIFIED", "RESTRICTIONS_ALLOWED", "RESTRICTIONS_RESTRICTED" ] }, "tcaRestrictions": { "description": "Optional. If tca_restrictions is ENABLED then the instance will have restrictions needed for building Trusted Core Access (TCA) compliant builds. DO NOT USE: In-Development feature.", "type": "string", "enumDescriptions": [ "TCA restrictions are not specified, defaulting to RESTRICTIONS_DISABLED.", "TCA restrictions are disabled for the instance.", "V1 version of TCA restrictions are enabled for the instance. These include: 1. ActionIsolation to be ENFORCED. 2. ImmutableMetaPolicy to be true. 3. AdminOpsRestrictions to be RESTRICTED. 4. Using Shielded, Confidential and Software Trusted VMs as RBE workers, which use custom RBE TCA COS VM images and go through TPM attestation verification for various boot parameters. 5. Inputs and outputs of the actions on these VMs requires TPM attestation verification." ], "enum": [ "RESTRICTIONS_UNSPECIFIED", "RESTRICTIONS_DISABLED", "RESTRICTIONS_ENABLED_V1" ] } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateWorkerPoolRequest": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateWorkerPoolRequest", "description": "The request used for `CreateWorkerPool`.", "type": "object", "properties": { "parent": { "description": "Resource name of the instance in which to create the new worker pool. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.", "type": "string" }, "poolId": { "description": "ID of the created worker pool. A valid pool ID must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit.", "type": "string" }, "workerPool": { "description": "Specifies the worker pool to create. The name in the worker pool, if specified, is ignored.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool" }, "validateOnly": { "description": "Optional. If true, the request will be validated but not executed.", "type": "boolean" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool", "description": "A worker pool resource in the Remote Build Execution API.", "type": "object", "properties": { "name": { "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.", "type": "string" }, "workerConfig": { "description": "Specifies the properties, such as machine type and disk size, used for creating workers in a worker pool.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig" }, "workerCount": { "description": "The desired number of workers in the worker pool. Must be a value between 0 and 15000.", "type": "string", "format": "int64" }, "state": { "description": "Output only. State of the worker pool.", "type": "string", "enumDescriptions": [ "Not a valid state, but the default value of the enum.", "The worker pool is in state `CREATING` once `CreateWorkerPool` is called and before all requested workers are ready.", "The worker pool is in state `RUNNING` when all its workers are ready for use.", "The worker pool is in state `UPDATING` once `UpdateWorkerPool` is called and before the new configuration has all the requested workers ready for use, and no older configuration has any workers. At that point the state transitions to `RUNNING`.", "The worker pool is in state `DELETING` once the `Delete` method is called and before the deletion completes.", "The worker pool is in state `INACTIVE` when the instance hosting the worker pool in not running." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "RUNNING", "UPDATING", "DELETING", "INACTIVE" ] }, "autoscale": { "description": "The autoscale policy to apply on a pool.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale" }, "channel": { "description": "Channel specifies the release channel of the pool.", "type": "string" }, "hostOs": { "description": "HostOS specifies the OS version of the image for the worker VMs.", "type": "string" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig", "description": "Defines the configuration to be used for creating workers in the worker pool.", "type": "object", "properties": { "machineType": { "description": "Required. Machine type of the worker, such as `e2-standard-2`. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that `f1-micro` and `g1-small` are not yet supported.", "type": "string" }, "minCpuPlatform": { "description": "Minimum CPU platform to use when creating the worker. See [CPU Platforms](https://cloud.google.com/compute/docs/cpu-platforms).", "type": "string" }, "diskType": { "description": "Required. Disk Type to use for the worker. See [Storage options](https://cloud.google.com/compute/docs/disks/#introduction). Currently only `pd-standard` and `pd-ssd` are supported.", "type": "string" }, "diskSizeGb": { "description": "Required. Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/", "type": "string", "format": "int64" }, "reserved": { "description": "Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See [Preemptible VMs](https://cloud.google.com/preemptible-vms/) for more details.", "type": "boolean" }, "labels": { "description": "Labels associated with the workers. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International letters are permitted. Label keys must start with a letter. Label values are optional. There can not be more than 64 labels per resource.", "type": "object", "additionalProperties": { "type": "string" } }, "networkAccess": { "description": "Determines the type of network access granted to workers. Possible values: - \"public\": Workers can connect to the public internet. - \"private\": Workers can only connect to Google APIs and services. - \"restricted-private\": Workers can only connect to Google APIs that are reachable through `restricted.googleapis.com` (`199.36.153.4/30`).", "type": "string" }, "accelerator": { "description": "The accelerator card attached to each VM.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfig" }, "maxConcurrentActions": { "description": "The maximum number of actions a worker can execute concurrently.", "type": "string", "format": "int64" }, "vmImage": { "description": "The name of the image used by each VM.", "type": "string" }, "soleTenantNodeType": { "description": "The node type name to be used for sole-tenant nodes.", "type": "string" }, "zones": { "description": "Optional. Zones in the region where the pool VMs should be. Leave empty for no restrictions.", "type": "array", "items": { "type": "string" } }, "attachedDisks": { "description": "Optional. Specifies the disks that will be attached.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaDisks" }, "userServiceAccounts": { "description": "Optional. List of user service accounts. The last service account in the list is what the user code will run as. The rest of the service accounts constitute the impersonation chain. For example, if len(user_service_accounts) == 2 and if the VM's service account is RBE's P4SA, then RBE'S P4SA should be granted the Service Account Token Creator role on user_service_accounts[0] and user_service_accounts[0] should be granted the Service Account Token Creator role on user_service_accounts[1].", "type": "array", "items": { "type": "string" } }, "networkAllowlist": { "description": "Optional. Specifies the network allowlist to use for the pool. Possible values: - \"\": No network filtering takes place. Any action with an allowlist will be rejected since it cannot be enforced. This is the default. - \"per_action\": Network access will be filtered according to the allowlist provided by the action. If no allowlist is provided, the default is to block all requests.", "type": "string" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfig": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfig", "description": "AcceleratorConfig defines the accelerator cards to attach to the VM.", "type": "object", "properties": { "acceleratorCount": { "description": "The number of guest accelerator cards exposed to each VM.", "type": "string", "format": "int64" }, "acceleratorType": { "description": "The type of accelerator to attach to each VM, e.g. \"nvidia-tesla-k80\" for nVidia Tesla K80.", "type": "string" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaDisks": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaDisks", "description": "Disks defines the disks that would be attached to the workers.", "type": "object", "properties": { "localSsd": { "description": "Optional. Specifies the number of local SSDs to be attached. If specified, local SSDs will be used as the working directory.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaDisksLocalSSD" }, "dockerRootDisk": { "description": "Optional. Specifies the configuration for the docker root disk to be attached. If not specified, RBE will default to the RBE managed docker root disk.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaDisksPersistentDisk" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaDisksLocalSSD": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaDisksLocalSSD", "description": "LocalSSD specifies how to attach local SSD to the workers.", "type": "object", "properties": { "count": { "description": "Optional. The number of Local SSDs to be attached.", "type": "string", "format": "int64" }, "sizeGb": { "description": "Output only. The size of the local SSD in gb. Intended for informational purposes only.", "readOnly": true, "type": "string", "format": "int64" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaDisksPersistentDisk": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaDisksPersistentDisk", "description": "PersistentDisk specifies how to attach a persistent disk to the workers.", "type": "object", "properties": { "diskType": { "description": "Required. Type of disk attached (supported types are pd-standard and pd-ssd).", "type": "string" }, "diskSizeGb": { "description": "Required. Size of the disk in GB.", "type": "string", "format": "int64" }, "sourceImage": { "description": "Required. VM image to use for the disk.", "type": "string" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscale", "description": "Autoscale defines the autoscaling policy of a worker pool.", "type": "object", "properties": { "minSize": { "description": "Optional. The minimal number of workers. Must be greater than 0.", "type": "string", "format": "int64" }, "maxSize": { "description": "Optional. The maximal number of workers. Must be equal to or greater than min_size.", "type": "string", "format": "int64" }, "minIdleWorkers": { "description": "Optional. The minimum number of idle workers the autoscaler will aim to have in the pool at all times that are immediately available to accept a surge in build traffic. The pool size will still be constrained by min_size and max_size.", "type": "string", "format": "int64" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateWorkerPoolRequest": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateWorkerPoolRequest", "description": "The request used for UpdateWorkerPool.", "type": "object", "properties": { "workerPool": { "description": "Specifies the worker pool to update.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool" }, "updateMask": { "description": "The update mask applies to worker_pool. 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.", "type": "string", "format": "google-fieldmask" }, "validateOnly": { "description": "Optional. If true, the request will be validated but not executed.", "type": "boolean" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsResponse": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsResponse", "type": "object", "properties": { "workerPools": { "description": "The list of worker pools in a given instance.", "type": "array", "items": { "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool" } } } }, "BuildBazelRemoteExecutionV2Action": { "id": "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.", "type": "object", "properties": { "commandDigest": { "description": "The digest of the Command to run, which MUST be present in the ContentAddressableStorage.", "$ref": "BuildBazelRemoteExecutionV2Digest" }, "inputRootDigest": { "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.", "$ref": "BuildBazelRemoteExecutionV2Digest" }, "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.", "type": "string", "format": "google-duration" }, "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" }, "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.", "type": "string", "format": "byte" }, "platform": { "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.", "$ref": "BuildBazelRemoteExecutionV2Platform" } } }, "BuildBazelRemoteExecutionV2Digest": { "id": "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.", "type": "object", "properties": { "hash": { "description": "The hash, represented as a lowercase hexadecimal string, padded with leading zeroes up to the hash function length.", "type": "string" }, "sizeBytes": { "description": "The size of the blob, in bytes.", "type": "string", "format": "int64" } } }, "BuildBazelRemoteExecutionV2Platform": { "id": "BuildBazelRemoteExecutionV2Platform", "description": "A `Platform` is a set of requirements, such as hardware, operating system, or compiler toolchain, for an Action's execution environment. A `Platform` is represented as a series of key-value pairs representing the properties that are required of the platform.", "type": "object", "properties": { "properties": { "description": "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.", "type": "array", "items": { "$ref": "BuildBazelRemoteExecutionV2PlatformProperty" } } } }, "BuildBazelRemoteExecutionV2PlatformProperty": { "id": "BuildBazelRemoteExecutionV2PlatformProperty", "description": "A 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, 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. Both names and values are typically case-sensitive. Note that the platform is implicitly part of the action digest, so even tiny changes in the names or values (like changing case) may result in different action cache entries.", "type": "object", "properties": { "name": { "description": "The property name.", "type": "string" }, "value": { "description": "The property value.", "type": "string" } } }, "BuildBazelRemoteExecutionV2Command": { "id": "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.", "type": "object", "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.", "type": "array", "items": { "type": "string" } }, "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.", "type": "array", "items": { "$ref": "BuildBazelRemoteExecutionV2CommandEnvironmentVariable" } }, "outputFiles": { "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.", "deprecated": true, "type": "array", "items": { "type": "string" } }, "outputDirectories": { "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.", "deprecated": true, "type": "array", "items": { "type": "string" } }, "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!", "type": "array", "items": { "type": "string" } }, "platform": { "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.", "deprecated": true, "$ref": "BuildBazelRemoteExecutionV2Platform" }, "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" }, "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`.", "type": "array", "items": { "type": "string" } }, "outputDirectoryFormat": { "description": "The format that the worker should use to store the contents of output directories. In case this field is set to a value that is not supported by the worker, the worker SHOULD interpret this field as TREE_ONLY. The worker MAY store output directories in formats that are a superset of what was requested (e.g., interpreting DIRECTORY_ONLY as TREE_AND_DIRECTORY).", "type": "string", "enumDescriptions": [ "The client is only interested in receiving output directories in the form of a single Tree object, using the `tree_digest` field.", "The client is only interested in receiving output directories in the form of a hierarchy of separately stored Directory objects, using the `root_directory_digest` field.", "The client is interested in receiving output directories both in the form of a single Tree object and a hierarchy of separately stored Directory objects, using both the `tree_digest` and `root_directory_digest` fields." ], "enum": [ "TREE_ONLY", "DIRECTORY_ONLY", "TREE_AND_DIRECTORY" ] } } }, "BuildBazelRemoteExecutionV2CommandEnvironmentVariable": { "id": "BuildBazelRemoteExecutionV2CommandEnvironmentVariable", "description": "An `EnvironmentVariable` is one variable to set in the running program's environment.", "type": "object", "properties": { "name": { "description": "The variable name.", "type": "string" }, "value": { "description": "The variable value.", "type": "string" } } }, "BuildBazelRemoteExecutionV2ExecuteResponse": { "id": "BuildBazelRemoteExecutionV2ExecuteResponse", "description": "The response message for Execution.Execute, which will be contained in the response field of the Operation.", "type": "object", "properties": { "result": { "description": "The result of the action.", "$ref": "BuildBazelRemoteExecutionV2ActionResult" }, "cachedResult": { "description": "True if the result was served from cache, false if it was executed.", "type": "boolean" }, "status": { "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.", "$ref": "GoogleRpcStatus" }, "serverLogs": { "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", "additionalProperties": { "$ref": "BuildBazelRemoteExecutionV2LogFile" } }, "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" } } }, "BuildBazelRemoteExecutionV2ActionResult": { "id": "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.", "type": "object", "properties": { "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.", "type": "array", "items": { "$ref": "BuildBazelRemoteExecutionV2OutputFile" } }, "outputFileSymlinks": { "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`.", "deprecated": true, "type": "array", "items": { "$ref": "BuildBazelRemoteExecutionV2OutputSymlink" } }, "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.", "type": "array", "items": { "$ref": "BuildBazelRemoteExecutionV2OutputSymlink" } }, "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.", "type": "array", "items": { "$ref": "BuildBazelRemoteExecutionV2OutputDirectory" } }, "outputDirectorySymlinks": { "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`.", "deprecated": true, "type": "array", "items": { "$ref": "BuildBazelRemoteExecutionV2OutputSymlink" } }, "exitCode": { "description": "The exit code of the command.", "type": "integer", "format": "int32" }, "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.", "type": "string", "format": "byte" }, "stdoutDigest": { "description": "The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage.", "$ref": "BuildBazelRemoteExecutionV2Digest" }, "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.", "type": "string", "format": "byte" }, "stderrDigest": { "description": "The digest for a blob containing the standard error of the action, which can be retrieved from the ContentAddressableStorage.", "$ref": "BuildBazelRemoteExecutionV2Digest" }, "executionMetadata": { "description": "The details of the execution that originally produced this result.", "$ref": "BuildBazelRemoteExecutionV2ExecutedActionMetadata" } } }, "BuildBazelRemoteExecutionV2OutputFile": { "id": "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.", "type": "object", "properties": { "path": { "description": "The full path of the file relative to the working directory, 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.", "type": "string" }, "digest": { "description": "The digest of the file's content.", "$ref": "BuildBazelRemoteExecutionV2Digest" }, "isExecutable": { "description": "True if file is executable, false otherwise.", "type": "boolean" }, "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.", "type": "string", "format": "byte" }, "nodeProperties": { "$ref": "BuildBazelRemoteExecutionV2NodeProperties" } } }, "BuildBazelRemoteExecutionV2NodeProperties": { "id": "BuildBazelRemoteExecutionV2NodeProperties", "description": "Node properties for FileNodes, DirectoryNodes, and SymlinkNodes. The server is responsible for specifying the properties that it accepts.", "type": "object", "properties": { "properties": { "description": "A list of string-based NodeProperties.", "type": "array", "items": { "$ref": "BuildBazelRemoteExecutionV2NodeProperty" } }, "mtime": { "description": "The file's last modification timestamp.", "type": "string", "format": "google-datetime" }, "unixMode": { "description": "The UNIX file mode, e.g., 0755.", "type": "integer", "format": "uint32" } } }, "BuildBazelRemoteExecutionV2NodeProperty": { "id": "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.", "type": "object", "properties": { "name": { "description": "The property name.", "type": "string" }, "value": { "description": "The property value.", "type": "string" } } }, "BuildBazelRemoteExecutionV2OutputSymlink": { "id": "BuildBazelRemoteExecutionV2OutputSymlink", "description": "An `OutputSymlink` is similar to a Symlink, but it is used as an output in an `ActionResult`. `OutputSymlink` is binary-compatible with `SymlinkNode`.", "type": "object", "properties": { "path": { "description": "The full path of the symlink relative to the working directory, 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.", "type": "string" }, "target": { "description": "The target path of the symlink. The path separator is a forward slash `/`. The target path can be relative to the parent directory of the symlink or it can be an absolute path starting with `/`. Support for absolute paths can be checked using the Capabilities API. `..` components are allowed anywhere in the target path.", "type": "string" }, "nodeProperties": { "$ref": "BuildBazelRemoteExecutionV2NodeProperties" } } }, "BuildBazelRemoteExecutionV2OutputDirectory": { "id": "BuildBazelRemoteExecutionV2OutputDirectory", "description": "An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file.", "type": "object", "properties": { "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": { "description": "The digest of the encoded Tree proto containing the directory's contents.", "$ref": "BuildBazelRemoteExecutionV2Digest" }, "isTopologicallySorted": { "description": "If set, consumers MAY make the following assumptions about the directories contained in 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 \u003c\u003c 3) | 2 == 0x0a: First record (the root directory). - (2 \u003c\u003c 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" }, "rootDirectoryDigest": { "description": "The digest of the encoded Directory proto containing the contents of the directory's root. If both `tree_digest` and `root_directory_digest` are set, this field MUST match the digest of the root directory contained in the Tree message.", "$ref": "BuildBazelRemoteExecutionV2Digest" } } }, "BuildBazelRemoteExecutionV2ExecutedActionMetadata": { "id": "BuildBazelRemoteExecutionV2ExecutedActionMetadata", "description": "ExecutedActionMetadata contains details about a completed execution.", "type": "object", "properties": { "worker": { "description": "The name of the worker which ran the execution.", "type": "string" }, "queuedTimestamp": { "description": "When was the action added to the queue.", "type": "string", "format": "google-datetime" }, "workerStartTimestamp": { "description": "When the worker received the action.", "type": "string", "format": "google-datetime" }, "workerCompletedTimestamp": { "description": "When the worker completed the action, including all stages.", "type": "string", "format": "google-datetime" }, "inputFetchStartTimestamp": { "description": "When the worker started fetching action inputs.", "type": "string", "format": "google-datetime" }, "inputFetchCompletedTimestamp": { "description": "When the worker finished fetching action inputs.", "type": "string", "format": "google-datetime" }, "executionStartTimestamp": { "description": "When the worker started executing the action command.", "type": "string", "format": "google-datetime" }, "executionCompletedTimestamp": { "description": "When the worker completed executing the action command.", "type": "string", "format": "google-datetime" }, "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`.", "type": "string", "format": "google-duration" }, "outputUploadStartTimestamp": { "description": "When the worker started uploading action outputs.", "type": "string", "format": "google-datetime" }, "outputUploadCompletedTimestamp": { "description": "When the worker finished uploading action outputs.", "type": "string", "format": "google-datetime" }, "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.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "BuildBazelRemoteExecutionV2LogFile": { "id": "BuildBazelRemoteExecutionV2LogFile", "description": "A `LogFile` is a log stored in the CAS.", "type": "object", "properties": { "digest": { "description": "The digest of the log contents.", "$ref": "BuildBazelRemoteExecutionV2Digest" }, "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" } } }, "BuildBazelRemoteExecutionV2ExecuteOperationMetadata": { "id": "BuildBazelRemoteExecutionV2ExecuteOperationMetadata", "description": "Metadata about an ongoing execution, which will be contained in the metadata field of the Operation.", "type": "object", "properties": { "stage": { "description": "The current stage of execution.", "type": "string", "enumDescriptions": [ "Invalid value.", "Checking the result against the cache.", "Currently idle, awaiting a free machine to execute.", "Currently being executed by a worker.", "Finished execution." ], "enum": [ "UNKNOWN", "CACHE_CHECK", "QUEUED", "EXECUTING", "COMPLETED" ] }, "actionDigest": { "description": "The digest of the Action being executed.", "$ref": "BuildBazelRemoteExecutionV2Digest" }, "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" }, "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" }, "partialExecutionMetadata": { "description": "The client can read this field to view details about the ongoing execution.", "$ref": "BuildBazelRemoteExecutionV2ExecutedActionMetadata" }, "digestFunction": { "description": "The digest function that was used to compute the action digest. If the digest function used is one of BLAKE3, MD5, MURMUR3, SHA1, SHA256, SHA256TREE, SHA384, SHA512, or VSO, the server MAY leave this field unset. In that case the client SHOULD infer the digest function using the length of the action digest hash and the digest functions announced in the server's capabilities.", "type": "string", "enumDescriptions": [ "It is an error for the server to return this value.", "The SHA-256 digest function.", "The SHA-1 digest function.", "The MD5 digest function.", "The Microsoft \"VSO-Hash\" paged SHA256 digest function. See https://github.com/microsoft/BuildXL/blob/master/Documentation/Specs/PagedHash.md .", "The SHA-384 digest function.", "The SHA-512 digest function.", "Murmur3 128-bit digest function, x64 variant. Note that this is not a cryptographic hash function and its collision properties are not strongly guaranteed. See https://github.com/aappleby/smhasher/wiki/MurmurHash3 .", "The SHA-256 digest function, modified to use a Merkle tree for large objects. This permits implementations to store large blobs as a decomposed sequence of 2^j sized chunks, where j \u003e= 10, while being able to validate integrity at the chunk level. Furthermore, on systems that do not offer dedicated instructions for computing SHA-256 hashes (e.g., the Intel SHA and ARMv8 cryptographic extensions), SHA256TREE hashes can be computed more efficiently than plain SHA-256 hashes by using generic SIMD extensions, such as Intel AVX2 or ARM NEON. SHA256TREE hashes are computed as follows: - For blobs that are 1024 bytes or smaller, the hash is computed using the regular SHA-256 digest function. - For blobs that are more than 1024 bytes in size, the hash is computed as follows: 1. The blob is partitioned into a left (leading) and right (trailing) blob. These blobs have lengths m and n respectively, where m = 2^k and 0 \u003c n \u003c= m. 2. Hashes of the left and right blob, Hash(left) and Hash(right) respectively, are computed by recursively applying the SHA256TREE algorithm. 3. A single invocation is made to the SHA-256 block cipher with the following parameters: M = Hash(left) || Hash(right) H = { 0xcbbb9d5d, 0x629a292a, 0x9159015a, 0x152fecd8, 0x67332667, 0x8eb44a87, 0xdb0c2e0d, 0x47b5481d, } The values of H are the leading fractional parts of the square roots of the 9th to the 16th prime number (23 to 53). This differs from plain SHA-256, where the first eight prime numbers (2 to 19) are used, thereby preventing trivial hash collisions between small and large objects. 4. The hash of the full blob can then be obtained by concatenating the outputs of the block cipher: Hash(blob) = a || b || c || d || e || f || g || h Addition of the original values of H, as normally done through the use of the Davies-Meyer structure, is not performed. This isn't necessary, as the block cipher is only invoked once. Test vectors of this digest function can be found in the accompanying sha256tree_test_vectors.txt file.", "The BLAKE3 hash function. See https://github.com/BLAKE3-team/BLAKE3.", "Identical to SHA1, except that \"blob ${sizeBytes}\\0\" is prepended to the blob's contents before hashing, where ${sizeBytes} corresponds to the decimal size of the original blob. This allows hashes of files to be converted from and to the ones used by the Git version control system." ], "enum": [ "UNKNOWN", "SHA256", "SHA1", "MD5", "VSO", "SHA384", "SHA512", "MURMUR3", "SHA256TREE", "BLAKE3", "GITSHA1" ] } } }, "BuildBazelRemoteExecutionV2RequestMetadata": { "id": "BuildBazelRemoteExecutionV2RequestMetadata", "description": "An 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: `build.bazel.remote.execution.v2.requestmetadata-bin` * contents: the base64 encoded binary `RequestMetadata` message. Note: the gRPC library serializes binary headers encoded in base64 by default (https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md#requests). Therefore, if the gRPC library is used to pass/retrieve this metadata, the user may ignore the base64 encoding and assume it is simply serialized as a binary message.", "type": "object", "properties": { "toolDetails": { "description": "The details for the tool invoking the requests.", "$ref": "BuildBazelRemoteExecutionV2ToolDetails" }, "actionId": { "description": "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.", "type": "string" }, "toolInvocationId": { "description": "An identifier that ties multiple actions together to a final result. For example, multiple actions are required to build and run foo_test.", "type": "string" }, "correlatedInvocationsId": { "description": "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.", "type": "string" }, "actionMnemonic": { "description": "A brief description of the kind of action, for example, CppCompile or GoLink. There is no standard agreed set of values for this, and they are expected to vary between different client tools.", "type": "string" }, "targetId": { "description": "An identifier for the target which produced this action. No guarantees are made around how many actions may relate to a single target.", "type": "string" }, "configurationId": { "description": "An identifier for the configuration in which the target was built, e.g. for differentiating building host tools or different target platforms. There is no expectation that this value will have any particular structure, or equality across invocations, though some client tools may offer these guarantees.", "type": "string" } } }, "BuildBazelRemoteExecutionV2ToolDetails": { "id": "BuildBazelRemoteExecutionV2ToolDetails", "description": "Details for the tool used to call the API.", "type": "object", "properties": { "toolName": { "description": "Name of the tool, e.g. bazel.", "type": "string" }, "toolVersion": { "description": "Version of the tool used for the request, e.g. 5.0.3.", "type": "string" } } }, "BuildBazelRemoteExecutionV2Tree": { "id": "BuildBazelRemoteExecutionV2Tree", "description": "A `Tree` contains all the Directory protos in a single directory Merkle tree, compressed into one message.", "type": "object", "properties": { "root": { "description": "The root directory in the tree.", "$ref": "BuildBazelRemoteExecutionV2Directory" }, "children": { "description": "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`. Servers SHOULD ensure that these are ordered consistently such that two actions producing equivalent output directories on the same server implementation also produce Tree messages with matching digests.", "type": "array", "items": { "$ref": "BuildBazelRemoteExecutionV2Directory" } } } }, "BuildBazelRemoteExecutionV2Directory": { "id": "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 `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 } ] } ```", "type": "object", "properties": { "files": { "description": "The files in the directory.", "type": "array", "items": { "$ref": "BuildBazelRemoteExecutionV2FileNode" } }, "directories": { "description": "The subdirectories in the directory.", "type": "array", "items": { "$ref": "BuildBazelRemoteExecutionV2DirectoryNode" } }, "symlinks": { "description": "The symlinks in the directory.", "type": "array", "items": { "$ref": "BuildBazelRemoteExecutionV2SymlinkNode" } }, "nodeProperties": { "$ref": "BuildBazelRemoteExecutionV2NodeProperties" } } }, "BuildBazelRemoteExecutionV2FileNode": { "id": "BuildBazelRemoteExecutionV2FileNode", "description": "A `FileNode` represents a single file and associated metadata.", "type": "object", "properties": { "name": { "description": "The name of the file.", "type": "string" }, "digest": { "description": "The digest of the file's content.", "$ref": "BuildBazelRemoteExecutionV2Digest" }, "isExecutable": { "description": "True if file is executable, false otherwise.", "type": "boolean" }, "nodeProperties": { "$ref": "BuildBazelRemoteExecutionV2NodeProperties" } } }, "BuildBazelRemoteExecutionV2DirectoryNode": { "id": "BuildBazelRemoteExecutionV2DirectoryNode", "description": "A `DirectoryNode` represents a child of a Directory which is itself a `Directory` and its associated metadata.", "type": "object", "properties": { "name": { "description": "The name of the directory.", "type": "string" }, "digest": { "description": "The digest of the Directory object represented. See Digest for information about how to take the digest of a proto message.", "$ref": "BuildBazelRemoteExecutionV2Digest" } } }, "BuildBazelRemoteExecutionV2SymlinkNode": { "id": "BuildBazelRemoteExecutionV2SymlinkNode", "description": "A `SymlinkNode` represents a symbolic link.", "type": "object", "properties": { "name": { "description": "The name of the symlink.", "type": "string" }, "target": { "description": "The target path of the symlink. The path separator is a forward slash `/`. The target path can be relative to the parent directory of the symlink or it can be an absolute path starting with `/`. Support for absolute paths can be checked using the Capabilities API. `..` components are allowed anywhere in the target path as logical canonicalization may lead to different behavior in the presence of directory symlinks (e.g. `foo/../bar` may not be the same as `bar`). To reduce potential cache misses, canonicalization is still recommended where this is possible without impacting correctness.", "type": "string" }, "nodeProperties": { "$ref": "BuildBazelRemoteExecutionV2NodeProperties" } } }, "GoogleDevtoolsRemotebuildbotCommandDurations": { "id": "GoogleDevtoolsRemotebuildbotCommandDurations", "description": "CommandDuration contains the various duration metrics tracked when a bot performs a command.", "type": "object", "properties": { "overall": { "description": "The time spent completing the command, in total.", "type": "string", "format": "google-duration" }, "execution": { "description": "The time spent executing the command (i.e., doing useful work).", "type": "string", "format": "google-duration" }, "download": { "description": "The time spent downloading the input files and constructing the working directory.", "type": "string", "format": "google-duration" }, "upload": { "description": "The time spent uploading the output files.", "type": "string", "format": "google-duration" }, "dockerPrep": { "description": "The time spent preparing the command to be run in a Docker container (includes pulling the Docker image, if necessary).", "type": "string", "format": "google-duration" }, "isoPrepDone": { "description": "The timestamp when preparation is done and bot starts downloading files.", "type": "string", "format": "google-datetime" }, "execStartTime": { "description": "The timestamp when execution begins.", "type": "string", "format": "google-datetime" }, "downloadStartTime": { "description": "The timestamp when downloading the input files begins.", "type": "string", "format": "google-datetime" }, "uploadStartTime": { "description": "The timestamp when uploading the output files begins.", "type": "string", "format": "google-datetime" }, "dockerPrepStartTime": { "description": "The timestamp when docker preparation begins.", "type": "string", "format": "google-datetime" }, "cmWaitForAssignment": { "description": "The time spent waiting for Container Manager to assign an asynchronous container for execution.", "type": "string", "format": "google-duration" }, "casRelease": { "description": "The time spent to release the CAS blobs used by the task.", "type": "string", "format": "google-duration" } } }, "GoogleDevtoolsRemotebuildbotCommandEvents": { "id": "GoogleDevtoolsRemotebuildbotCommandEvents", "description": "CommandEvents contains counters for the number of warnings and errors that occurred during the execution of a command.", "type": "object", "properties": { "numWarnings": { "description": "The number of warnings reported.", "type": "string", "format": "uint64" }, "numErrors": { "description": "The number of errors reported.", "type": "string", "format": "uint64" }, "dockerCacheHit": { "description": "Indicates whether we are using a cached Docker image (true) or had to pull the Docker image (false) for this command.", "type": "boolean" }, "inputCacheMissFiles": { "description": "The input cache miss rate as a fraction of the number of input files.", "type": "number", "format": "float" }, "inputCacheMissBytes": { "description": "The input cache miss rate as a fraction of the total size of input files.", "type": "number", "format": "float" }, "dockerImageName": { "description": "Docker Image name.", "type": "string" }, "usedAsyncContainer": { "description": "Indicates whether an asynchronous container was used for execution.", "type": "boolean" }, "cmUsage": { "description": "Indicates if and how Container Manager is being used for task execution.", "type": "string", "enumDescriptions": [ "Container Manager is disabled or not running for this execution.", "Container Manager is enabled and there was a matching container available for use during execution.", "Container Manager is enabled, but there was no matching container available for execution." ], "enum": [ "CONFIG_NONE", "CONFIG_MATCH", "CONFIG_MISMATCH" ] }, "outputLocation": { "description": "Indicates whether output files and/or output directories were found relative to the execution root or to the user provided work directory or both or none.", "type": "string", "enumDescriptions": [ "Location is set to LOCATION_UNDEFINED for tasks where the working directorty is not specified or is identical to the execution root directory.", "No output files or directories were found neither relative to the execution root directory nor relative to the working directory.", "Output files or directories were found relative to the execution root directory but not relative to the working directory.", "Output files or directories were found relative to the working directory but not relative to the execution root directory.", "Output files or directories were found both relative to the execution root directory and relative to the working directory.", "Output files or directories were found relative to the execution root directory but not relative to the working directory. In addition at least one output file or directory was found outside of the working directory such that a working-directory-relative-path would have needed to start with a `..`.", "Output files or directories were found both relative to the execution root directory and relative to the working directory. In addition at least one exec-root-relative output file or directory was found outside of the working directory such that a working-directory-relative-path would have needed to start with a `..`." ], "enumDeprecated": [ false, false, false, false, false, true, true ], "enum": [ "LOCATION_UNDEFINED", "LOCATION_NONE", "LOCATION_EXEC_ROOT_RELATIVE", "LOCATION_WORKING_DIR_RELATIVE", "LOCATION_EXEC_ROOT_AND_WORKING_DIR_RELATIVE", "LOCATION_EXEC_ROOT_RELATIVE_OUTPUT_OUTSIDE_WORKING_DIR", "LOCATION_EXEC_ROOT_AND_WORKING_DIR_RELATIVE_OUTPUT_OUTSIDE_WORKING_DIR" ] }, "inputMountType": { "description": "Indicates how the input tree was mounted for the action.", "type": "string", "enumDescriptions": [ "The mechanism for mounting the input tree is unspecified.", "The input tree was mounted from a read-write overlay filesystem.", "The input tree was mounted as a read-write bind mount. The CAS proxy will use file watchers and/or post-action scanning of inputs to catch modfiications to the input blobs.", "The input tree was mounted as a read-only bind mount, with a separate writable directories mounted where outputs are expected.", "The input tree was mounted from a CartFS directory." ], "enum": [ "MOUNT_UNSPECIFIED", "MOUNT_OVERLAY", "MOUNT_WRITABLE", "MOUNT_READ_ONLY", "MOUNT_CARTFS" ] }, "inputTreeStats": { "description": "Contains stats about the action input metadata tree that was fetched to determine the action's inputs.", "$ref": "GoogleDevtoolsRemotebuildbotInputTreeStats" } } }, "GoogleDevtoolsRemotebuildbotInputTreeStats": { "id": "GoogleDevtoolsRemotebuildbotInputTreeStats", "type": "object", "properties": { "totalNodes": { "description": "Overall number of nodes in the tree.", "type": "integer", "format": "int32" }, "totalFiles": { "description": "Overall number of files in the tree.", "type": "integer", "format": "int32" }, "totalSymlinks": { "description": "Overall number of symlinks in the tree.", "type": "integer", "format": "int32" }, "maxDepth": { "description": "Tree depth.", "type": "integer", "format": "int32" }, "totalSize": { "description": "Total size in bytes of all files in the tree.", "type": "string", "format": "int64" }, "processingTimeMillis": { "description": "Time spent retrieving and processing the tree.", "type": "string", "format": "int64" } } }, "GoogleDevtoolsRemotebuildbotCommandStatus": { "id": "GoogleDevtoolsRemotebuildbotCommandStatus", "description": "The internal status of the command result.", "type": "object", "properties": { "code": { "description": "The status code.", "type": "string", "enumDescriptions": [ "The command succeeded.", "The command input was invalid.", "The command had passed its expiry time while it was still running.", "The resources requested by the command were not found.", "The command failed due to permission errors.", "The command failed because of some invariants expected by the underlying system have been broken. This usually indicates a bug wit the system.", "The command was aborted.", "The command failed because the system is not in a state required for the command, e.g. the command inputs cannot be found on the server.", "The bot failed to do the cleanup, e.g. unable to delete the command working directory or the command process.", "The bot failed to download the inputs.", "Unknown error.", "The bot failed to upload the outputs.", "The bot tried to upload files having a total size that is too large.", "The bot failed to login to docker.", "The bot failed to pull docker image.", "The bot failed to check docker images.", "The inputs contain duplicate files.", "The bot doesn't have the permissions to pull docker images.", "The docker image cannot be found.", "Working directory is not found.", "Working directory is not under the base directory", "There are issues with docker service/runtime.", "The command failed with \"no cuda-capable device is detected\" error.", "The bot encountered errors from remote CAS when downloading blobs.", "The bot encountered errors from remote CAS when uploading blobs.", "The local casproxy is not running.", "The bot couldn't start the container.", "The docker ulimit is not valid.", "The docker runtime is unknown.", "The docker capability is unknown.", "The command failed with unknown docker errors.", "Docker failed to run containers with CreateComputeSystem error.", "Docker failed to run containers with hcsshim::PrepareLayer error.", "Docker incompatible operating system error.", "Docker failed to create OCI runtime because of file not found.", "Docker failed to create OCI runtime because of permission denied.", "Docker failed to create process because of file not found.", "Docker failed to run containers with CreateComputeSystem error that involves an incorrect parameter (more specific version of DOCKER_CREATE_COMPUTE_SYSTEM_ERROR that is user-caused).", "Docker failed to create an overlay mount because of too many levels of symbolic links.", "The local Container Manager is not running.", "Docker failed because a request was denied by the organization's policy.", "Working directory is not relative", "Docker cannot find the container specified in the command. This error is likely to only occur if an asynchronous container is not running when the command is run.", "Docker cannot pull an image because a blob is missing in the repo. May be due to a bad/incomplete image push or partial deletion of underlying blob layers.", "The docker volume specification is invalid (e.g. root).", "Docker failed to create OCI runtime because input root cannot be proc.", "Docker failed to start OCI runtime because of file not found.", "Docker failed to run because the layerchain json was invalid (see b/234782336).", "Docker failed to create OCI runtime because of incompatible cuda version.", "The local Worker Manager is not running.", "Docker failed to start OCI runtime because of file format error.", "Docker failed to start OCI runtime because of permission denied.", "Docker failed because of permission denied.", "The bot failed to update the network proxy policy.", "Failed to impersonate the service account.", "Trying to write a file with a filename that is too long.", "The bot failed to get the network activity log.", "The bot failed to upload the network activity log.", "Failed to start a process because NPROC is too low.", "An error occurred during the start of tetragon container.", "An error occurred during the generation of the buildgraph.", "An error occurred while uploading the generated buildgraph. Next tag to use: 62." ], "enum": [ "OK", "INVALID_ARGUMENT", "DEADLINE_EXCEEDED", "NOT_FOUND", "PERMISSION_DENIED", "INTERNAL", "ABORTED", "FAILED_PRECONDITION", "CLEANUP_ERROR", "DOWNLOAD_INPUTS_ERROR", "UNKNOWN", "UPLOAD_OUTPUTS_ERROR", "UPLOAD_OUTPUTS_BYTES_LIMIT_EXCEEDED", "DOCKER_LOGIN_ERROR", "DOCKER_IMAGE_PULL_ERROR", "DOCKER_IMAGE_EXIST_ERROR", "DUPLICATE_INPUTS", "DOCKER_IMAGE_PERMISSION_DENIED", "DOCKER_IMAGE_NOT_FOUND", "WORKING_DIR_NOT_FOUND", "WORKING_DIR_NOT_IN_BASE_DIR", "DOCKER_UNAVAILABLE", "NO_CUDA_CAPABLE_DEVICE", "REMOTE_CAS_DOWNLOAD_ERROR", "REMOTE_CAS_UPLOAD_ERROR", "LOCAL_CASPROXY_NOT_RUNNING", "DOCKER_CREATE_CONTAINER_ERROR", "DOCKER_INVALID_ULIMIT", "DOCKER_UNKNOWN_RUNTIME", "DOCKER_UNKNOWN_CAPABILITY", "DOCKER_UNKNOWN_ERROR", "DOCKER_CREATE_COMPUTE_SYSTEM_ERROR", "DOCKER_PREPARELAYER_ERROR", "DOCKER_INCOMPATIBLE_OS_ERROR", "DOCKER_CREATE_RUNTIME_FILE_NOT_FOUND", "DOCKER_CREATE_RUNTIME_PERMISSION_DENIED", "DOCKER_CREATE_PROCESS_FILE_NOT_FOUND", "DOCKER_CREATE_COMPUTE_SYSTEM_INCORRECT_PARAMETER_ERROR", "DOCKER_TOO_MANY_SYMBOLIC_LINK_LEVELS", "LOCAL_CONTAINER_MANAGER_NOT_RUNNING", "DOCKER_IMAGE_VPCSC_PERMISSION_DENIED", "WORKING_DIR_NOT_RELATIVE", "DOCKER_MISSING_CONTAINER", "DOCKER_MISSING_BLOB_IN_IMAGE", "DOCKER_INVALID_VOLUME", "DOCKER_CREATE_RUNTIME_CANNOT_MOUNT_TO_PROC", "DOCKER_START_RUNTIME_FILE_NOT_FOUND", "DOCKER_CREATE_INVALID_LAYERCHAIN_JSON", "INCOMPATIBLE_CUDA_VERSION", "LOCAL_WORKER_MANAGER_NOT_RUNNING", "DOCKER_START_RUNTIME_FILE_FORMAT_ERROR", "DOCKER_START_RUNTIME_PERMISSION_DENIED", "DOCKER_PERMISSION_DENIED", "NETWORK_PROXY_UPDATE_POLICY_ERROR", "SERVICE_ACCOUNT_IMPERSONATION_DENIED", "INVALID_FILENAME", "NETWORK_PROXY_GET_NETWORK_ACTIVITY_LOG_ERROR", "NETWORK_PROXY_UPLOAD_NETWORK_ACTIVITY_LOG_ERROR", "NPROC_EXCEEDED", "BUILDGRAPH_START_ERROR", "BUILDGRAPH_GENERATION_ERROR", "BUILDGRAPH_UPLOAD_ERROR" ] }, "message": { "description": "The error message.", "type": "string" } } }, "GoogleDevtoolsRemotebuildbotResourceUsage": { "id": "GoogleDevtoolsRemotebuildbotResourceUsage", "description": "ResourceUsage is the system resource usage of the host machine.", "type": "object", "properties": { "diskUsage": { "$ref": "GoogleDevtoolsRemotebuildbotResourceUsageStat" }, "memoryUsage": { "$ref": "GoogleDevtoolsRemotebuildbotResourceUsageStat" }, "cpuUsedPercent": { "type": "number", "format": "double" }, "totalDiskIoStats": { "$ref": "GoogleDevtoolsRemotebuildbotResourceUsageIOStats" }, "botState": { "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "UNSPECIFIED", "IDLE", "BUSY" ] }, "dockerRootDiskUsage": { "$ref": "GoogleDevtoolsRemotebuildbotResourceUsageStat" } } }, "GoogleDevtoolsRemotebuildbotResourceUsageStat": { "id": "GoogleDevtoolsRemotebuildbotResourceUsageStat", "type": "object", "properties": { "total": { "type": "string", "format": "uint64" }, "used": { "type": "string", "format": "uint64" } } }, "GoogleDevtoolsRemotebuildbotResourceUsageIOStats": { "id": "GoogleDevtoolsRemotebuildbotResourceUsageIOStats", "type": "object", "properties": { "readCount": { "type": "string", "format": "uint64" }, "writeCount": { "type": "string", "format": "uint64" }, "readBytesCount": { "type": "string", "format": "uint64" }, "writeBytesCount": { "type": "string", "format": "uint64" }, "readTimeMs": { "type": "string", "format": "uint64" }, "writeTimeMs": { "type": "string", "format": "uint64" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest", "description": "The request used for `GetInstance`.", "type": "object", "properties": { "name": { "description": "Required. Name of the instance to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.", "type": "string" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteInstanceRequest": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteInstanceRequest", "description": "The request used for `DeleteInstance`.", "type": "object", "properties": { "name": { "description": "Required. Name of the instance to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.", "type": "string" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateInstanceRequest": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateInstanceRequest", "description": "The request used for `UpdateInstance`.", "type": "object", "properties": { "name": { "description": "Optional. Deprecated: Use instance.Name instead. Name of the instance to update. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.", "deprecated": true, "type": "string" }, "updateMask": { "description": "Optional. 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.", "type": "string", "format": "google-fieldmask" }, "loggingEnabled": { "description": "Optional. Deprecated: Use instance.logging_enabled instead. Whether to enable Stackdriver logging for this instance.", "deprecated": true, "type": "boolean" }, "instance": { "description": "Required. Specifies the instance to update.", "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance" }, "validateOnly": { "description": "Optional. If true, the request will be validated but not executed.", "type": "boolean" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesRequest": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesRequest", "description": "The request used for `ListInstances`.", "type": "object", "properties": { "parent": { "description": "Required. Resource name of the project. Format: `projects/[PROJECT_ID]`.", "type": "string" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetWorkerPoolRequest": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetWorkerPoolRequest", "description": "The request used for GetWorkerPool.", "type": "object", "properties": { "name": { "description": "Name of the worker pool to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`.", "type": "string" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteWorkerPoolRequest": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteWorkerPoolRequest", "description": "The request used for DeleteWorkerPool.", "type": "object", "properties": { "name": { "description": "Name of the worker pool to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`.", "type": "string" } } }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsRequest": { "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsRequest", "type": "object", "properties": { "parent": { "description": "Resource name of the instance. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.", "type": "string" }, "filter": { "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 `:`, `=`, `!=`, `\u003e`, `\u003e=`, `\u003c=` or `\u003c`. 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 \u003e 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`", "type": "string" } } }, "GoogleDevtoolsRemoteworkersV1test2AdminTemp": { "id": "GoogleDevtoolsRemoteworkersV1test2AdminTemp", "description": "AdminTemp is a prelimiary set of administration tasks. It's called \"Temp\" because we do not yet know the best way to represent admin tasks; it's possible that this will be entirely replaced in later versions of this API. If this message proves to be sufficient, it will be renamed in the alpha or beta release of this API. This message (suitably marshalled into a protobuf.Any) can be used as the inline_assignment field in a lease; the lease assignment field should simply be `\"admin\"` in these cases. This message is heavily based on Swarming administration tasks from the LUCI project (http://github.com/luci/luci-py/appengine/swarming).", "type": "object", "properties": { "command": { "description": "The admin action; see `Command` for legal values.", "type": "string", "enumDescriptions": [ "Illegal value.", "Download and run a new version of the bot. `arg` will be a resource accessible via `ByteStream.Read` to obtain the new bot code.", "Restart the bot without downloading a new version. `arg` will be a message to log.", "Shut down the bot. `arg` will be a task resource name (similar to those in tasks.proto) that the bot can use to tell the server that it is terminating.", "Restart the host computer. `arg` will be a message to log." ], "enum": [ "UNSPECIFIED", "BOT_UPDATE", "BOT_RESTART", "BOT_TERMINATE", "HOST_RESTART" ] }, "arg": { "description": "The argument to the admin action; see `Command` for semantics.", "type": "string" } } }, "GoogleDevtoolsRemoteworkersV1test2CommandTask": { "id": "GoogleDevtoolsRemoteworkersV1test2CommandTask", "description": "Describes a shell-style task to execute, suitable for providing as the Bots interface's `Lease.payload` field.", "type": "object", "properties": { "inputs": { "description": "The inputs to the task.", "$ref": "GoogleDevtoolsRemoteworkersV1test2CommandTaskInputs" }, "expectedOutputs": { "description": "The expected outputs from the task.", "$ref": "GoogleDevtoolsRemoteworkersV1test2CommandTaskOutputs" }, "timeouts": { "description": "The timeouts of this task.", "$ref": "GoogleDevtoolsRemoteworkersV1test2CommandTaskTimeouts" } } }, "GoogleDevtoolsRemoteworkersV1test2CommandTaskInputs": { "id": "GoogleDevtoolsRemoteworkersV1test2CommandTaskInputs", "description": "Describes the inputs to a shell-style task.", "type": "object", "properties": { "arguments": { "description": "The command itself to run (e.g., argv). This field should be passed directly to the underlying operating system, and so it must be sensible to that operating system. For example, on Windows, the first argument might be \"C:\\Windows\\System32\\ping.exe\" - that is, using drive letters and backslashes. A command for a *nix system, on the other hand, would use forward slashes. All other fields in the RWAPI must consistently use forward slashes, since those fields may be interpreted by both the service and the bot.", "type": "array", "items": { "type": "string" } }, "inputRootDigest": { "description": "The digest of the Merkle tree root of the inputs to the task. If present, the 'files' field should be empty.", "$ref": "GoogleDevtoolsRemoteworkersV1test2Digest" }, "files": { "description": "The input filesystem to be set up prior to the task beginning. The contents should be a repeated set of FileMetadata messages though other formats are allowed if better for the implementation (eg, a LUCI-style .isolated file). This field is repeated since implementations might want to cache the metadata, in which case it may be useful to break up portions of the filesystem that change frequently (eg, specific input files) from those that don't (eg, standard header files).", "type": "array", "items": { "$ref": "GoogleDevtoolsRemoteworkersV1test2Digest" } }, "inlineBlobs": { "description": "Inline contents for blobs expected to be needed by the bot to execute the task. For example, contents of entries in `files` or blobs that are indirectly referenced by an entry there. The bot should check against this list before downloading required task inputs to reduce the number of communications between itself and the remote CAS server.", "type": "array", "items": { "$ref": "GoogleDevtoolsRemoteworkersV1test2Blob" } }, "environmentVariables": { "description": "All environment variables required by the task.", "type": "array", "items": { "$ref": "GoogleDevtoolsRemoteworkersV1test2CommandTaskInputsEnvironmentVariable" } }, "workingDirectory": { "description": "Directory from which a command is executed. It is a relative directory with respect to the bot's working directory (i.e., \"./\"). If it is non-empty, then it must exist under \"./\". Otherwise, \"./\" will be used.", "type": "string" } } }, "GoogleDevtoolsRemoteworkersV1test2Digest": { "id": "GoogleDevtoolsRemoteworkersV1test2Digest", "description": "The CommandTask and CommandResult messages assume the existence of a service that can serve blobs of content, identified by a hash and size known as a \"digest.\" The method by which these blobs may be retrieved is not specified here, but a model implementation is in the Remote Execution API's \"ContentAddressibleStorage\" interface. In the context of the RWAPI, a Digest will virtually always refer to the contents of a file or a directory. The latter is represented by the byte-encoded Directory message.", "type": "object", "properties": { "hash": { "description": "A string-encoded hash (eg \"1a2b3c\", not the byte array [0x1a, 0x2b, 0x3c]) using an implementation-defined hash algorithm (eg SHA-256).", "type": "string" }, "sizeBytes": { "description": "The size of the contents. While this is not strictly required as part of an identifier (after all, any given hash will have exactly one canonical size), it's useful in almost all cases when one might want to send or retrieve blobs of content and is included here for this reason.", "type": "string", "format": "int64" } } }, "GoogleDevtoolsRemoteworkersV1test2Blob": { "id": "GoogleDevtoolsRemoteworkersV1test2Blob", "description": "Describes a blob of binary content with its digest.", "type": "object", "properties": { "digest": { "description": "The digest of the blob. This should be verified by the receiver.", "$ref": "GoogleDevtoolsRemoteworkersV1test2Digest" }, "contents": { "description": "The contents of the blob.", "type": "string", "format": "byte" } } }, "GoogleDevtoolsRemoteworkersV1test2CommandTaskInputsEnvironmentVariable": { "id": "GoogleDevtoolsRemoteworkersV1test2CommandTaskInputsEnvironmentVariable", "description": "An environment variable required by this task.", "type": "object", "properties": { "name": { "description": "The envvar name.", "type": "string" }, "value": { "description": "The envvar value.", "type": "string" } } }, "GoogleDevtoolsRemoteworkersV1test2CommandTaskOutputs": { "id": "GoogleDevtoolsRemoteworkersV1test2CommandTaskOutputs", "description": "Describes the expected outputs of the command.", "type": "object", "properties": { "files": { "description": "A list of expected files, relative to the execution root. All paths MUST be delimited by forward slashes.", "type": "array", "items": { "type": "string" } }, "directories": { "description": "A list of expected directories, relative to the execution root. All paths MUST be delimited by forward slashes.", "type": "array", "items": { "type": "string" } }, "stdoutDestination": { "description": "The destination to which any stdout should be sent. The method by which the bot should send the stream contents to that destination is not defined in this API. As examples, the destination could be a file referenced in the `files` field in this message, or it could be a URI that must be written via the ByteStream API.", "type": "string" }, "stderrDestination": { "description": "The destination to which any stderr should be sent. The method by which the bot should send the stream contents to that destination is not defined in this API. As examples, the destination could be a file referenced in the `files` field in this message, or it could be a URI that must be written via the ByteStream API.", "type": "string" } } }, "GoogleDevtoolsRemoteworkersV1test2CommandTaskTimeouts": { "id": "GoogleDevtoolsRemoteworkersV1test2CommandTaskTimeouts", "description": "Describes the timeouts associated with this task.", "type": "object", "properties": { "execution": { "description": "This specifies the maximum time that the task can run, excluding the time required to download inputs or upload outputs. That is, the worker will terminate the task if it runs longer than this.", "type": "string", "format": "google-duration" }, "idle": { "description": "This specifies the maximum amount of time the task can be idle - that is, go without generating some output in either stdout or stderr. If the process is silent for more than the specified time, the worker will terminate the task.", "type": "string", "format": "google-duration" }, "shutdown": { "description": "If the execution or IO timeouts are exceeded, the worker will try to gracefully terminate the task and return any existing logs. However, tasks may be hard-frozen in which case this process will fail. This timeout specifies how long to wait for a terminated task to shut down gracefully (e.g. via SIGTERM) before we bring down the hammer (e.g. SIGKILL on *nix, CTRL_BREAK_EVENT on Windows).", "type": "string", "format": "google-duration" } } }, "GoogleDevtoolsRemoteworkersV1test2CommandResult": { "id": "GoogleDevtoolsRemoteworkersV1test2CommandResult", "description": "All information about the execution of a command, suitable for providing as the Bots interface's `Lease.result` field.", "type": "object", "properties": { "status": { "description": "An overall status for the command. For example, if the command timed out, this might have a code of DEADLINE_EXCEEDED; if it was killed by the OS for memory exhaustion, it might have a code of RESOURCE_EXHAUSTED.", "$ref": "GoogleRpcStatus" }, "exitCode": { "description": "The exit code of the process. An exit code of \"0\" should only be trusted if `status` has a code of OK (otherwise it may simply be unset).", "type": "integer", "format": "int32" }, "outputs": { "description": "The output files. The blob referenced by the digest should contain one of the following (implementation-dependent): * A marshalled DirectoryMetadata of the returned filesystem * A LUCI-style .isolated file", "$ref": "GoogleDevtoolsRemoteworkersV1test2Digest" }, "duration": { "description": "The elapsed time between calling Accept and Complete. The server will also have its own idea of what this should be, but this excludes the overhead of the RPCs and the bot response time.", "deprecated": true, "type": "string", "format": "google-duration" }, "overhead": { "description": "The amount of time *not* spent executing the command (ie uploading/downloading files).", "deprecated": true, "type": "string", "format": "google-duration" }, "metadata": { "description": "Implementation-dependent metadata about the task. Both servers and bots may define messages which can be encoded here; bots are free to provide metadata in multiple formats, and servers are free to choose one or more of the values to process and ignore others. In particular, it is *not* considered an error for the bot to provide the server with a field that it doesn't know about.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "GoogleDevtoolsRemoteworkersV1test2CommandOutputs": { "id": "GoogleDevtoolsRemoteworkersV1test2CommandOutputs", "description": "DEPRECATED - use CommandResult instead. Describes the actual outputs from the task.", "type": "object", "properties": { "exitCode": { "description": "exit_code is only fully reliable if the status' code is OK. If the task exceeded its deadline or was cancelled, the process may still produce an exit code as it is cancelled, and this will be populated, but a successful (zero) is unlikely to be correct unless the status code is OK.", "type": "integer", "format": "int32" }, "outputs": { "description": "The output files. The blob referenced by the digest should contain one of the following (implementation-dependent): * A marshalled DirectoryMetadata of the returned filesystem * A LUCI-style .isolated file", "$ref": "GoogleDevtoolsRemoteworkersV1test2Digest" } } }, "GoogleDevtoolsRemoteworkersV1test2CommandOverhead": { "id": "GoogleDevtoolsRemoteworkersV1test2CommandOverhead", "description": "DEPRECATED - use CommandResult instead. Can be used as part of CompleteRequest.metadata, or are part of a more sophisticated message.", "type": "object", "properties": { "duration": { "description": "The elapsed time between calling Accept and Complete. The server will also have its own idea of what this should be, but this excludes the overhead of the RPCs and the bot response time.", "type": "string", "format": "google-duration" }, "overhead": { "description": "The amount of time *not* spent executing the command (ie uploading/downloading files).", "type": "string", "format": "google-duration" } } }, "GoogleDevtoolsRemoteworkersV1test2FileMetadata": { "id": "GoogleDevtoolsRemoteworkersV1test2FileMetadata", "description": "The metadata for a file. Similar to the equivalent message in the Remote Execution API.", "type": "object", "properties": { "path": { "description": "The path of this file. If this message is part of the CommandOutputs.outputs fields, the path is relative to the execution root and must correspond to an entry in CommandTask.outputs.files. If this message is part of a Directory message, then the path is relative to the root of that directory. All paths MUST be delimited by forward slashes.", "type": "string" }, "digest": { "description": "A pointer to the contents of the file. The method by which a client retrieves the contents from a CAS system is not defined here.", "$ref": "GoogleDevtoolsRemoteworkersV1test2Digest" }, "contents": { "description": "If the file is small enough, its contents may also or alternatively be listed here.", "type": "string", "format": "byte" }, "isExecutable": { "description": "Properties of the file", "type": "boolean" } } }, "GoogleDevtoolsRemoteworkersV1test2DirectoryMetadata": { "id": "GoogleDevtoolsRemoteworkersV1test2DirectoryMetadata", "description": "The metadata for a directory. Similar to the equivalent message in the Remote Execution API.", "type": "object", "properties": { "path": { "description": "The path of the directory, as in FileMetadata.path.", "type": "string" }, "digest": { "description": "A pointer to the contents of the directory, in the form of a marshalled Directory message.", "$ref": "GoogleDevtoolsRemoteworkersV1test2Digest" } } }, "GoogleDevtoolsRemoteworkersV1test2Directory": { "id": "GoogleDevtoolsRemoteworkersV1test2Directory", "description": "The contents of a directory. Similar to the equivalent message in the Remote Execution API.", "type": "object", "properties": { "files": { "description": "The files in this directory", "type": "array", "items": { "$ref": "GoogleDevtoolsRemoteworkersV1test2FileMetadata" } }, "directories": { "description": "Any subdirectories", "type": "array", "items": { "$ref": "GoogleDevtoolsRemoteworkersV1test2DirectoryMetadata" } } } } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "id": "remotebuildexecution:v1alpha" }