{ "version": "v2", "description": "TPU API provides customers with access to Google TPU technology.", "resources": { "projects": { "resources": { "locations": { "methods": { "get": { "description": "Gets information about a location.", "response": { "$ref": "Location" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}", "parameterOrder": [ "name" ], "id": "tpu.projects.locations.get", "path": "v2/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "name": { "location": "path", "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true } } }, "list": { "description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v2/{+name}/locations", "parameters": { "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "type": "string", "location": "query" }, "extraLocationTypes": { "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "type": "string", "location": "query", "repeated": true }, "name": { "required": true, "pattern": "^projects/[^/]+$", "location": "path", "description": "The resource that owns the locations collection, if applicable.", "type": "string" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "The maximum number of results to return. If not set, the service selects a default." } }, "response": { "$ref": "ListLocationsResponse" }, "id": "tpu.projects.locations.list", "httpMethod": "GET", "flatPath": "v2/projects/{projectsId}/locations" }, "generateServiceIdentity": { "description": "Generates the Cloud TPU service identity for the project.", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource name.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GenerateServiceIdentityResponse" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}:generateServiceIdentity", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v2/{+parent}:generateServiceIdentity", "request": { "$ref": "GenerateServiceIdentityRequest" }, "id": "tpu.projects.locations.generateServiceIdentity" } }, "resources": { "runtimeVersions": { "methods": { "get": { "id": "tpu.projects.locations.runtimeVersions.get", "parameterOrder": [ "name" ], "description": "Gets a runtime version.", "path": "v2/{+name}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "description": "Required. The resource name.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/runtimeVersions/[^/]+$", "type": "string" } }, "response": { "$ref": "RuntimeVersion" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/runtimeVersions/{runtimeVersionsId}" }, "list": { "id": "tpu.projects.locations.runtimeVersions.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "filter": { "type": "string", "description": "List filter.", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource name.", "type": "string", "location": "path", "required": true }, "pageSize": { "description": "The maximum number of items to return.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The next_page_token value returned from a previous List request, if any.", "type": "string", "location": "query" }, "orderBy": { "location": "query", "description": "Sort results.", "type": "string" } }, "parameterOrder": [ "parent" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/runtimeVersions", "description": "Lists runtime versions supported by this API.", "path": "v2/{+parent}/runtimeVersions", "response": { "$ref": "ListRuntimeVersionsResponse" } } } }, "queuedResources": { "methods": { "get": { "id": "tpu.projects.locations.queuedResources.get", "path": "v2/{+name}", "parameterOrder": [ "name" ], "httpMethod": "GET", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queuedResources/{queuedResourcesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/queuedResources/[^/]+$", "type": "string", "location": "path", "description": "Required. The resource name.", "required": true } }, "description": "Gets details of a queued resource.", "response": { "$ref": "QueuedResource" } }, "list": { "parameterOrder": [ "parent" ], "httpMethod": "GET", "description": "Lists queued resources.", "parameters": { "parent": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource name." }, "pageSize": { "location": "query", "description": "Optional. The maximum number of items to return.", "format": "int32", "type": "integer" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous List request, if any.", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "ListQueuedResourcesResponse" }, "id": "tpu.projects.locations.queuedResources.list", "path": "v2/{+parent}/queuedResources", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queuedResources" }, "reset": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queuedResources/{queuedResourcesId}:reset", "id": "tpu.projects.locations.queuedResources.reset", "response": { "$ref": "Operation" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/queuedResources/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the queued resource.", "required": true } }, "description": "Resets a QueuedResource TPU instance", "path": "v2/{+name}:reset", "request": { "$ref": "ResetQueuedResourceRequest" }, "parameterOrder": [ "name" ] }, "create": { "path": "v2/{+parent}/queuedResources", "id": "tpu.projects.locations.queuedResources.create", "parameterOrder": [ "parent" ], "description": "Creates a QueuedResource TPU instance.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "QueuedResource" }, "response": { "$ref": "Operation" }, "parameters": { "requestId": { "location": "query", "type": "string", "description": "Optional. Idempotent request UUID." }, "parent": { "required": true, "location": "path", "type": "string", "description": "Required. The parent resource name.", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "queuedResourceId": { "description": "Optional. The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format.", "location": "query", "type": "string" } }, "httpMethod": "POST", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queuedResources" }, "delete": { "response": { "$ref": "Operation" }, "description": "Deletes a QueuedResource TPU instance.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queuedResources/{queuedResourcesId}", "id": "tpu.projects.locations.queuedResources.delete", "parameters": { "requestId": { "location": "query", "type": "string", "description": "Optional. Idempotent request UUID." }, "force": { "description": "Optional. If set to true, all running nodes belonging to this queued resource will be deleted first and then the queued resource will be deleted. Otherwise (i.e. force=false), the queued resource will only be deleted if its nodes have already been deleted or the queued resource is in the ACCEPTED, FAILED, or SUSPENDED state.", "type": "boolean", "location": "query" }, "name": { "type": "string", "required": true, "location": "path", "description": "Required. The resource name.", "pattern": "^projects/[^/]+/locations/[^/]+/queuedResources/[^/]+$" } }, "path": "v2/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameterOrder": [ "name" ] } } }, "acceleratorTypes": { "methods": { "list": { "path": "v2/{+parent}/acceleratorTypes", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/acceleratorTypes", "response": { "$ref": "ListAcceleratorTypesResponse" }, "id": "tpu.projects.locations.acceleratorTypes.list", "httpMethod": "GET", "parameters": { "parent": { "type": "string", "description": "Required. The parent resource name.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "filter": { "type": "string", "description": "List filter.", "location": "query" }, "orderBy": { "type": "string", "location": "query", "description": "Sort results." }, "pageSize": { "format": "int32", "location": "query", "description": "The maximum number of items to return.", "type": "integer" }, "pageToken": { "location": "query", "description": "The next_page_token value returned from a previous List request, if any.", "type": "string" } }, "description": "Lists accelerator types supported by this API." }, "get": { "response": { "$ref": "AcceleratorType" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/acceleratorTypes/{acceleratorTypesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/acceleratorTypes/[^/]+$", "required": true } }, "description": "Gets AcceleratorType.", "parameterOrder": [ "name" ], "path": "v2/{+name}", "id": "tpu.projects.locations.acceleratorTypes.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "nodes": { "methods": { "getGuestAttributes": { "httpMethod": "POST", "description": "Retrieves the guest attributes for the node.", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", "description": "Required. The resource name.", "type": "string", "location": "path" } }, "id": "tpu.projects.locations.nodes.getGuestAttributes", "path": "v2/{+name}:getGuestAttributes", "parameterOrder": [ "name" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:getGuestAttributes", "response": { "$ref": "GetGuestAttributesResponse" }, "request": { "$ref": "GetGuestAttributesRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v2/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "description": "Required. The resource name.", "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", "type": "string", "location": "path" } }, "httpMethod": "GET", "description": "Gets the details of a node.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}", "id": "tpu.projects.locations.nodes.get", "response": { "$ref": "Node" } }, "start": { "path": "v2/{+name}:start", "id": "tpu.projects.locations.nodes.start", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:start", "response": { "$ref": "Operation" }, "httpMethod": "POST", "description": "Starts a node.", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", "description": "Required. The resource name.", "location": "path" } }, "parameterOrder": [ "name" ], "request": { "$ref": "StartNodeRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "stop": { "description": "Stops a node. This operation is only available with single TPU nodes.", "id": "tpu.projects.locations.nodes.stop", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The resource name." } }, "parameterOrder": [ "name" ], "httpMethod": "POST", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:stop", "path": "v2/{+name}:stop", "response": { "$ref": "Operation" }, "request": { "$ref": "StopNodeRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "id": "tpu.projects.locations.nodes.list", "path": "v2/{+parent}/nodes", "httpMethod": "GET", "parameters": { "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "The maximum number of items to return." }, "parent": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "Required. The parent resource name." }, "pageToken": { "location": "query", "description": "The next_page_token value returned from a previous List request, if any.", "type": "string" } }, "parameterOrder": [ "parent" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nodes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists nodes.", "response": { "$ref": "ListNodesResponse" } }, "patch": { "response": { "$ref": "Operation" }, "parameters": { "updateMask": { "format": "google-fieldmask", "type": "string", "description": "Required. Mask of fields from Node to update. Supported fields: [description, tags, labels, metadata, network_config.enable_external_ips].", "location": "query" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", "type": "string", "required": true, "description": "Output only. Immutable. The name of the TPU." } }, "request": { "$ref": "Node" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}", "parameterOrder": [ "name" ], "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the configurations of a node.", "id": "tpu.projects.locations.nodes.patch", "path": "v2/{+name}" }, "create": { "id": "tpu.projects.locations.nodes.create", "request": { "$ref": "Node" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nodes", "parameterOrder": [ "parent" ], "httpMethod": "POST", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "Required. The parent resource name." }, "nodeId": { "location": "query", "description": "The unqualified resource name.", "type": "string" } }, "path": "v2/{+parent}/nodes", "description": "Creates a node." }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "path": "v2/{+name}", "parameters": { "name": { "type": "string", "description": "Required. The resource name.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$" } }, "response": { "$ref": "Operation" }, "description": "Deletes a node.", "parameterOrder": [ "name" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}", "id": "tpu.projects.locations.nodes.delete" } } }, "operations": { "methods": { "delete": { "id": "tpu.projects.locations.operations.delete", "path": "v2/{+name}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "httpMethod": "DELETE", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "response": { "$ref": "Empty" } }, "cancel": { "response": { "$ref": "Empty" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "path": "v2/{+name}:cancel", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "id": "tpu.projects.locations.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameters": { "name": { "location": "path", "type": "string", "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true } } }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "httpMethod": "GET", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations", "id": "tpu.projects.locations.operations.list", "response": { "$ref": "ListOperationsResponse" }, "parameters": { "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "name": { "location": "path", "type": "string", "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "pageSize": { "format": "int32", "type": "integer", "location": "query", "description": "The standard list page size." } }, "path": "v2/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "path": "v2/{+name}", "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.", "response": { "$ref": "Operation" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "id": "tpu.projects.locations.operations.get", "parameterOrder": [ "name" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "description": "The name of the operation resource.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } } } } } } } } } }, "servicePath": "", "fullyEncodeReservedExpansion": true, "name": "tpu", "mtlsRootUrl": "https://tpu.mtls.googleapis.com/", "rootUrl": "https://tpu.googleapis.com/", "documentationLink": "https://cloud.google.com/tpu/", "batchPath": "batch", "canonicalName": "TPU", "ownerDomain": "google.com", "ownerName": "Google", "protocol": "rest", "version_module": true, "basePath": "", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "discoveryVersion": "v1", "parameters": { "callback": { "type": "string", "location": "query", "description": "JSONP" }, "access_token": { "type": "string", "location": "query", "description": "OAuth access token." }, "fields": { "location": "query", "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, "alt": { "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "enum": [ "json", "media", "proto" ], "location": "query", "type": "string", "description": "Data format for response." }, "upload_protocol": { "type": "string", "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "prettyPrint": { "location": "query", "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true" }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "$.xgafv": { "type": "string", "description": "V1 error format.", "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ], "enum": [ "1", "2" ] }, "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" }, "key": { "location": "query", "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.", "type": "string" } }, "id": "tpu:v2", "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." } } } }, "schemas": { "Symptom": { "description": "A Symptom instance.", "id": "Symptom", "type": "object", "properties": { "symptomType": { "type": "string", "enum": [ "SYMPTOM_TYPE_UNSPECIFIED", "LOW_MEMORY", "OUT_OF_MEMORY", "EXECUTE_TIMED_OUT", "MESH_BUILD_FAIL", "HBM_OUT_OF_MEMORY", "PROJECT_ABUSE" ], "enumDescriptions": [ "Unspecified symptom.", "TPU VM memory is low.", "TPU runtime is out of memory.", "TPU runtime execution has timed out.", "TPU runtime fails to construct a mesh that recognizes each TPU device's neighbors.", "TPU HBM is out of memory.", "Abusive behaviors have been identified on the current project." ], "description": "Type of the Symptom." }, "details": { "type": "string", "description": "Detailed information of the current Symptom." }, "createTime": { "description": "Timestamp when the Symptom is created.", "format": "google-datetime", "type": "string" }, "workerId": { "description": "A string used to uniquely distinguish a worker within a TPU node.", "type": "string" } } }, "ActiveData": { "properties": {}, "description": "Further data for the active state.", "id": "ActiveData", "type": "object" }, "GuestAttributesValue": { "id": "GuestAttributesValue", "properties": { "items": { "description": "The list of guest attributes entries.", "type": "array", "items": { "$ref": "GuestAttributesEntry" } } }, "description": "Array of guest attribute namespace/key/value tuples.", "type": "object" }, "AcceleratorConfig": { "description": "A TPU accelerator configuration.", "id": "AcceleratorConfig", "properties": { "topology": { "description": "Required. Topology of TPU in chips.", "type": "string" }, "type": { "type": "string", "description": "Required. Type of TPU.", "enumDescriptions": [ "Unspecified version.", "TPU v2.", "TPU v3.", "TPU v4.", "TPU v5lite pod.", "TPU v5p.", "TPU v6e." ], "enum": [ "TYPE_UNSPECIFIED", "V2", "V3", "V4", "V5LITE_POD", "V5P", "V6E" ] } }, "type": "object" }, "ShieldedInstanceConfig": { "id": "ShieldedInstanceConfig", "properties": { "enableSecureBoot": { "type": "boolean", "description": "Defines whether the instance has Secure Boot enabled." } }, "description": "A set of Shielded Instance options.", "type": "object" }, "Guaranteed": { "id": "Guaranteed", "description": "Guaranteed tier definition.", "properties": { "minDuration": { "format": "google-duration", "type": "string", "description": "Optional. Defines the minimum duration of the guarantee. If specified, the requested resources will only be provisioned if they can be allocated for at least the given duration." } }, "type": "object" }, "ListLocationsResponse": { "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Location" } } }, "description": "The response message for Locations.ListLocations.", "id": "ListLocationsResponse" }, "QueueingPolicy": { "type": "object", "description": "Defines the policy of the QueuedRequest.", "id": "QueueingPolicy", "properties": { "validUntilDuration": { "description": "Optional. A relative time after which resources should not be created. If the request cannot be fulfilled by this time the request will be failed.", "type": "string", "format": "google-duration" }, "validAfterDuration": { "format": "google-duration", "type": "string", "description": "Optional. A relative time after which resources may be created." }, "validInterval": { "description": "Optional. An absolute time interval within which resources may be created.", "$ref": "Interval" }, "validAfterTime": { "format": "google-datetime", "description": "Optional. An absolute time after which resources may be created.", "type": "string" }, "validUntilTime": { "format": "google-datetime", "description": "Optional. An absolute time after which resources should not be created. If the request cannot be fulfilled by this time the request will be failed.", "type": "string" } } }, "StopNodeRequest": { "properties": {}, "id": "StopNodeRequest", "type": "object", "description": "Request for StopNode." }, "SchedulingConfig": { "description": "Sets the scheduling options for this node.", "id": "SchedulingConfig", "properties": { "spot": { "description": "Optional. Defines whether the node is Spot VM.", "type": "boolean" }, "reserved": { "description": "Whether the node is created under a reservation.", "type": "boolean" }, "preemptible": { "description": "Defines whether the node is preemptible.", "type": "boolean" } }, "type": "object" }, "StartNodeRequest": { "properties": {}, "id": "StartNodeRequest", "description": "Request for StartNode.", "type": "object" }, "ResetQueuedResourceRequest": { "description": "Request for ResetQueuedResource.", "id": "ResetQueuedResourceRequest", "properties": {}, "type": "object" }, "BootDiskConfig": { "id": "BootDiskConfig", "type": "object", "description": "Sets the boot disk configuration for the TPU node.", "properties": { "customerEncryptionKey": { "description": "Optional. Customer encryption key for boot disk.", "$ref": "CustomerEncryptionKey" } } }, "SuspendedData": { "id": "SuspendedData", "description": "Further data for the suspended state.", "properties": {}, "type": "object" }, "NetworkConfig": { "properties": { "enableExternalIps": { "description": "Indicates that external IP addresses would be associated with the TPU workers. If set to false, the specified subnetwork or network should have Private Google Access enabled.", "type": "boolean" }, "queueCount": { "type": "integer", "format": "int32", "description": "Optional. Specifies networking queue count for TPU VM instance's network interface." }, "canIpForward": { "description": "Allows the TPU node to send and receive packets with non-matching destination or source IPs. This is required if you plan to use the TPU workers to forward routes.", "type": "boolean" }, "subnetwork": { "type": "string", "description": "The name of the subnetwork for the TPU node. It must be a preexisting Google Compute Engine subnetwork. If none is provided, \"default\" will be used." }, "network": { "description": "The name of the network for the TPU node. It must be a preexisting Google Compute Engine network. If none is provided, \"default\" will be used.", "type": "string" } }, "type": "object", "description": "Network related configurations.", "id": "NetworkConfig" }, "OperationMetadata": { "properties": { "cancelRequested": { "description": "Specifies if cancellation was requested for the operation.", "type": "boolean" }, "verb": { "description": "Name of the verb executed by the operation.", "type": "string" }, "statusDetail": { "description": "Human-readable status of the operation, if any.", "type": "string" }, "target": { "type": "string", "description": "Target of the operation - for example projects/project-1/connectivityTests/test-1" }, "createTime": { "format": "google-datetime", "type": "string", "description": "The time the operation was created." }, "apiVersion": { "description": "API version.", "type": "string" }, "endTime": { "type": "string", "description": "The time the operation finished running.", "format": "google-datetime" } }, "description": "Metadata describing an Operation", "id": "OperationMetadata", "type": "object" }, "SuspendingData": { "properties": {}, "description": "Further data for the suspending state.", "id": "SuspendingData", "type": "object" }, "ListQueuedResourcesResponse": { "properties": { "unreachable": { "type": "array", "description": "Locations that could not be reached.", "items": { "type": "string" } }, "nextPageToken": { "type": "string", "description": "The next page token or empty if none." }, "queuedResources": { "items": { "$ref": "QueuedResource" }, "description": "The listed queued resources.", "type": "array" } }, "description": "Response for ListQueuedResources.", "type": "object", "id": "ListQueuedResourcesResponse" }, "ServiceAccount": { "id": "ServiceAccount", "properties": { "email": { "description": "Email address of the service account. If empty, default Compute service account will be used.", "type": "string" }, "scope": { "type": "array", "items": { "type": "string" }, "description": "The list of scopes to be made available for this service account. If empty, access to all Cloud APIs will be allowed." } }, "type": "object", "description": "A service account." }, "MultisliceParams": { "id": "MultisliceParams", "type": "object", "description": "Parameters to specify for multislice QueuedResource requests. This message must be populated in case of multislice requests instead of node_id.", "properties": { "nodeCount": { "description": "Required. Number of nodes with this spec. The system will attempt to provision \"node_count\" nodes as part of the request. This needs to be \u003e 1.", "type": "integer", "format": "int32" }, "nodeIdPrefix": { "type": "string", "description": "Optional. Prefix of node_ids in case of multislice request. Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format. If node_count = 3 and node_id_prefix = \"np\", node ids of nodes created will be \"np-0\", \"np-1\", \"np-2\". If this field is not provided we use queued_resource_id as the node_id_prefix." } } }, "Interval": { "type": "object", "properties": { "startTime": { "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", "type": "string", "format": "google-datetime" }, "endTime": { "type": "string", "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", "format": "google-datetime" } }, "description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.", "id": "Interval" }, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", "type": "object", "properties": { "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" }, "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" }, "displayName": { "type": "string", "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"." }, "locationId": { "type": "string", "description": "The canonical id for this location. For example: `\"us-east1\"`." }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object", "additionalProperties": { "type": "string" } } } }, "GetGuestAttributesRequest": { "description": "Request for GetGuestAttributes.", "id": "GetGuestAttributesRequest", "type": "object", "properties": { "queryPath": { "type": "string", "description": "The guest attributes path to be queried." }, "workerIds": { "type": "array", "items": { "type": "string" }, "description": "The 0-based worker ID. If it is empty, all workers' GuestAttributes will be returned." } } }, "Spot": { "id": "Spot", "description": "Spot tier definition.", "properties": {}, "type": "object" }, "CustomerEncryptionKey": { "properties": { "kmsKeyName": { "description": "The name of the encryption key that is stored in Google Cloud KMS. For example: \"kmsKeyName\": \"projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY The fully-qualifed key name may be returned for resource GET requests. For example: \"kmsKeyName\": \"projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY/cryptoKeyVersions/1 ", "type": "string" } }, "type": "object", "id": "CustomerEncryptionKey", "description": "Defines the customer encryption key for disk encryption." }, "ProvisioningData": { "description": "Further data for the provisioning state.", "id": "ProvisioningData", "type": "object", "properties": {} }, "NetworkEndpoint": { "properties": { "port": { "description": "The port of this network endpoint.", "format": "int32", "type": "integer" }, "accessConfig": { "$ref": "AccessConfig", "description": "The access config for the TPU worker." }, "ipAddress": { "type": "string", "description": "The internal IP address of this network endpoint." } }, "id": "NetworkEndpoint", "description": "A network endpoint over which a TPU worker can be reached.", "type": "object" }, "QueuedResourceState": { "id": "QueuedResourceState", "type": "object", "description": "QueuedResourceState defines the details of the QueuedResource request.", "properties": { "state": { "description": "Output only. State of the QueuedResource request.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACCEPTED", "PROVISIONING", "FAILED", "DELETING", "ACTIVE", "SUSPENDING", "SUSPENDED", "WAITING_FOR_RESOURCES" ], "type": "string", "enumDescriptions": [ "State of the QueuedResource request is not known/set.", "The QueuedResource request has been received. We're still working on determining if we will be able to honor this request.", "The QueuedResource request has passed initial validation/admission control and has been persisted in the queue.", "The QueuedResource request has been selected. The associated resources are currently being provisioned (or very soon will begin provisioning).", "The request could not be completed. This may be due to some late-discovered problem with the request itself, or due to unavailability of resources within the constraints of the request (e.g., the 'valid until' start timing constraint expired).", "The QueuedResource is being deleted.", "The resources specified in the QueuedResource request have been provisioned and are ready for use by the end-user/consumer.", "The resources specified in the QueuedResource request are being deleted. This may have been initiated by the user, or the Cloud TPU service. Inspect the state data for more details.", "The resources specified in the QueuedResource request have been deleted.", "The QueuedResource request has passed initial validation and has been persisted in the queue. It will remain in this state until there are sufficient free resources to begin provisioning your request. Wait times will vary significantly depending on demand levels. When demand is high, not all requests can be immediately provisioned. If you need more reliable obtainability of TPUs consider purchasing a reservation. To put a limit on how long you are willing to wait, use [timing constraints](https://cloud.google.com/tpu/docs/queued-resources#request_a_queued_resource_before_a_specified_time)." ], "readOnly": true }, "suspendingData": { "readOnly": true, "description": "Output only. Further data for the suspending state.", "$ref": "SuspendingData" }, "stateInitiator": { "readOnly": true, "enum": [ "STATE_INITIATOR_UNSPECIFIED", "USER", "SERVICE" ], "enumDescriptions": [ "The state initiator is unspecified.", "The current QueuedResource state was initiated by the user.", "The current QueuedResource state was initiated by the service." ], "description": "Output only. The initiator of the QueuedResources's current state. Used to indicate whether the SUSPENDING/SUSPENDED state was initiated by the user or the service.", "type": "string" }, "provisioningData": { "readOnly": true, "description": "Output only. Further data for the provisioning state.", "$ref": "ProvisioningData" }, "failedData": { "$ref": "FailedData", "description": "Output only. Further data for the failed state.", "readOnly": true }, "creatingData": { "readOnly": true, "description": "Output only. Further data for the creating state.", "$ref": "CreatingData" }, "acceptedData": { "description": "Output only. Further data for the accepted state.", "readOnly": true, "$ref": "AcceptedData" }, "suspendedData": { "description": "Output only. Further data for the suspended state.", "$ref": "SuspendedData", "readOnly": true }, "activeData": { "readOnly": true, "$ref": "ActiveData", "description": "Output only. Further data for the active state." }, "deletingData": { "readOnly": true, "$ref": "DeletingData", "description": "Output only. Further data for the deleting state." } } }, "FailedData": { "description": "Further data for the failed state.", "type": "object", "properties": { "error": { "$ref": "Status", "description": "Output only. The error that caused the queued resource to enter the FAILED state.", "readOnly": true } }, "id": "FailedData" }, "DeletingData": { "id": "DeletingData", "description": "Further data for the deleting state.", "type": "object", "properties": {} }, "AcceptedData": { "description": "Further data for the accepted state.", "properties": {}, "type": "object", "id": "AcceptedData" }, "GuestAttributesEntry": { "description": "A guest attributes namespace/key/value entry.", "properties": { "key": { "description": "Key for the guest attribute entry.", "type": "string" }, "value": { "description": "Value for the guest attribute entry.", "type": "string" }, "namespace": { "description": "Namespace for the guest attribute entry.", "type": "string" } }, "type": "object", "id": "GuestAttributesEntry" }, "GetGuestAttributesResponse": { "description": "Response for GetGuestAttributes.", "properties": { "guestAttributes": { "type": "array", "items": { "$ref": "GuestAttributes" }, "description": "The guest attributes for the TPU workers." } }, "id": "GetGuestAttributesResponse", "type": "object" }, "RuntimeVersion": { "properties": { "version": { "type": "string", "description": "The runtime version." }, "name": { "description": "The resource name.", "type": "string" } }, "type": "object", "description": "A runtime version that a Node can be configured with.", "id": "RuntimeVersion" }, "GenerateServiceIdentityRequest": { "description": "Request for GenerateServiceIdentity.", "id": "GenerateServiceIdentityRequest", "type": "object", "properties": {} }, "Tpu": { "id": "Tpu", "type": "object", "description": "Details of the TPU resource(s) being requested.", "properties": { "nodeSpec": { "type": "array", "description": "Optional. The TPU node(s) being requested.", "items": { "$ref": "NodeSpec" } } } }, "UpcomingMaintenance": { "description": "Upcoming Maintenance notification information.", "type": "object", "properties": { "windowEndTime": { "type": "string", "description": "The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format." }, "windowStartTime": { "description": "The current start time of the maintenance window. This timestamp value is in RFC3339 text format.", "type": "string" }, "type": { "enumDescriptions": [ "No type specified. Do not use this value.", "Scheduled maintenance (e.g. maintenance after uptime guarantee is complete).", "Unscheduled maintenance (e.g. emergency maintenance during uptime guarantee)." ], "type": "string", "description": "Defines the type of maintenance.", "enum": [ "UNKNOWN_TYPE", "SCHEDULED", "UNSCHEDULED" ] }, "canReschedule": { "description": "Indicates if the maintenance can be customer triggered.", "type": "boolean" }, "maintenanceStatus": { "description": "The status of the maintenance.", "type": "string", "enumDescriptions": [ "Unknown maintenance status. Do not use this value.", "There is pending maintenance.", "There is ongoing maintenance on this VM." ], "enum": [ "UNKNOWN", "PENDING", "ONGOING" ] }, "latestWindowStartTime": { "type": "string", "description": "The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format." } }, "id": "UpcomingMaintenance" }, "QueuedResource": { "type": "object", "id": "QueuedResource", "description": "A QueuedResource represents a request for resources that will be placed in a queue and fulfilled when the necessary resources are available.", "properties": { "tpu": { "description": "Optional. Defines a TPU resource.", "$ref": "Tpu" }, "spot": { "description": "Optional. The Spot tier.", "$ref": "Spot" }, "reservationName": { "description": "Optional. Name of the reservation in which the resource should be provisioned. Format: projects/{project}/locations/{zone}/reservations/{reservation}", "type": "string" }, "state": { "readOnly": true, "description": "Output only. State of the QueuedResource request.", "$ref": "QueuedResourceState" }, "guaranteed": { "description": "Optional. The Guaranteed tier", "$ref": "Guaranteed" }, "name": { "description": "Output only. Immutable. The name of the QueuedResource.", "type": "string", "readOnly": true }, "createTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The time when the QueuedResource was created.", "type": "string" }, "queueingPolicy": { "description": "Optional. The queueing policy of the QueuedRequest.", "$ref": "QueueingPolicy" } } }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "id": "Operation", "properties": { "response": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "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" }, "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" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "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" }, "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "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." } } }, "Empty": { "id": "Empty", "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": {} }, "AttachedDisk": { "id": "AttachedDisk", "properties": { "mode": { "enum": [ "DISK_MODE_UNSPECIFIED", "READ_WRITE", "READ_ONLY" ], "type": "string", "enumDescriptions": [ "The disk mode is not known/set.", "Attaches the disk in read-write mode. Only one TPU node can attach a disk in read-write mode at a time.", "Attaches the disk in read-only mode. Multiple TPU nodes can attach a disk in read-only mode at a time." ], "description": "The mode in which to attach this disk. If not specified, the default is READ_WRITE mode. Only applicable to data_disks." }, "sourceDisk": { "type": "string", "description": "Specifies the full path to an existing disk. For example: \"projects/my-project/zones/us-central1-c/disks/my-disk\"." } }, "description": "A node-attached disk resource. Next ID: 8;", "type": "object" }, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "type": "object", "id": "ListOperationsResponse", "properties": { "operations": { "type": "array", "items": { "$ref": "Operation" }, "description": "A list of operations that matches the specified filter in the request." }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "unreachable": { "type": "array", "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" } } } }, "ServiceIdentity": { "properties": { "email": { "type": "string", "description": "The email address of the service identity." } }, "type": "object", "id": "ServiceIdentity", "description": "The per-product per-project service identity for Cloud TPU service." }, "Status": { "properties": { "details": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use." }, "code": { "type": "integer", "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code." }, "message": { "type": "string", "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." } }, "id": "Status", "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" }, "CreatingData": { "id": "CreatingData", "properties": {}, "description": "Further data for the creating state.", "type": "object" }, "ListAcceleratorTypesResponse": { "id": "ListAcceleratorTypesResponse", "description": "Response for ListAcceleratorTypes.", "properties": { "nextPageToken": { "type": "string", "description": "The next page token or empty if none." }, "acceleratorTypes": { "items": { "$ref": "AcceleratorType" }, "type": "array", "description": "The listed nodes." }, "unreachable": { "type": "array", "description": "Locations that could not be reached.", "items": { "type": "string" } } }, "type": "object" }, "GuestAttributes": { "type": "object", "properties": { "queryValue": { "$ref": "GuestAttributesValue", "description": "The value of the requested queried path." }, "queryPath": { "description": "The path to be queried. This can be the default namespace ('/') or a nested namespace ('/\\/') or a specified key ('/\\/\\')", "type": "string" } }, "description": "A guest attributes.", "id": "GuestAttributes" }, "AccessConfig": { "type": "object", "id": "AccessConfig", "properties": { "externalIp": { "readOnly": true, "description": "Output only. An external IP address associated with the TPU worker.", "type": "string" } }, "description": "An access config attached to the TPU worker." }, "ListNodesResponse": { "id": "ListNodesResponse", "type": "object", "properties": { "nextPageToken": { "description": "The next page token or empty if none.", "type": "string" }, "nodes": { "type": "array", "items": { "$ref": "Node" }, "description": "The listed nodes." }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" } }, "description": "Response for ListNodes." }, "NodeSpec": { "properties": { "node": { "$ref": "Node", "description": "Required. The node." }, "nodeId": { "type": "string", "description": "Optional. The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format. This is only specified when requesting a single node. In case of multislice requests, multislice_params must be populated instead." }, "parent": { "description": "Required. The parent resource name.", "type": "string" }, "multisliceParams": { "$ref": "MultisliceParams", "description": "Optional. Fields to specify in case of multislice request." } }, "id": "NodeSpec", "type": "object", "description": "Details of the TPU node(s) being requested. Users can request either a single node or multiple nodes. NodeSpec provides the specification for node(s) to be created." }, "Node": { "properties": { "name": { "readOnly": true, "type": "string", "description": "Output only. Immutable. The name of the TPU." }, "shieldedInstanceConfig": { "$ref": "ShieldedInstanceConfig", "description": "Shielded Instance options." }, "dataDisks": { "description": "The additional data disks for the Node.", "type": "array", "items": { "$ref": "AttachedDisk" } }, "networkConfigs": { "type": "array", "items": { "$ref": "NetworkConfig" }, "description": "Optional. Repeated network configurations for the TPU node. This field is used to specify multiple networks configs for the TPU node. network_config and network_configs are mutually exclusive, you can only specify one of them. If both are specified, an error will be returned." }, "apiVersion": { "readOnly": true, "enum": [ "API_VERSION_UNSPECIFIED", "V1_ALPHA1", "V1", "V2_ALPHA1", "V2" ], "description": "Output only. The API version that created this Node.", "type": "string", "enumDescriptions": [ "API version is unknown.", "TPU API V1Alpha1 version.", "TPU API V1 version.", "TPU API V2Alpha1 version.", "TPU API V2 version." ] }, "acceleratorType": { "type": "string", "description": "Optional. The type of hardware accelerators associated with this node." }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time when the node was created." }, "labels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Resource labels to represent user-provided metadata." }, "runtimeVersion": { "type": "string", "description": "Required. The runtime version running in the Node." }, "symptoms": { "type": "array", "description": "Output only. The Symptoms that have occurred to the TPU Node.", "readOnly": true, "items": { "$ref": "Symptom" } }, "networkConfig": { "description": "Network configurations for the TPU node. network_config and network_configs are mutually exclusive, you can only specify one of them. If both are specified, an error will be returned.", "$ref": "NetworkConfig" }, "id": { "readOnly": true, "description": "Output only. The unique identifier for the TPU Node.", "type": "string", "format": "int64" }, "networkEndpoints": { "readOnly": true, "type": "array", "description": "Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that runtime clients of the node reach out to the 0th entry in this map first.", "items": { "$ref": "NetworkEndpoint" } }, "queuedResource": { "type": "string", "description": "Output only. The qualified name of the QueuedResource that requested this Node.", "readOnly": true }, "healthDescription": { "description": "Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.", "readOnly": true, "type": "string" }, "description": { "description": "The user-supplied description of the TPU. Maximum of 512 characters.", "type": "string" }, "serviceAccount": { "description": "The Google Cloud Platform Service Account to be used by the TPU node VMs. If None is specified, the default compute service account will be used.", "$ref": "ServiceAccount" }, "multisliceNode": { "type": "boolean", "readOnly": true, "description": "Output only. Whether the Node belongs to a Multislice group." }, "upcomingMaintenance": { "$ref": "UpcomingMaintenance", "description": "Output only. Upcoming maintenance on this TPU node.", "readOnly": true }, "tags": { "type": "array", "description": "Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.", "items": { "type": "string" } }, "state": { "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "RESTARTING", "REIMAGING", "DELETING", "REPAIRING", "STOPPED", "STOPPING", "STARTING", "PREEMPTED", "TERMINATED", "HIDING", "HIDDEN", "UNHIDING", "UNKNOWN" ], "readOnly": true, "enumDescriptions": [ "TPU node state is not known/set.", "TPU node is being created.", "TPU node has been created.", "TPU node is restarting.", "TPU node is undergoing reimaging.", "TPU node is being deleted.", "TPU node is being repaired and may be unusable. Details can be found in the 'help_description' field.", "TPU node is stopped.", "TPU node is currently stopping.", "TPU node is currently starting.", "TPU node has been preempted. Only applies to Preemptible TPU Nodes.", "TPU node has been terminated due to maintenance or has reached the end of its life cycle (for preemptible nodes).", "TPU node is currently hiding.", "TPU node has been hidden.", "TPU node is currently unhiding.", "TPU node has unknown state after a failed repair." ], "description": "Output only. The current state for the TPU Node.", "type": "string" }, "bootDiskConfig": { "$ref": "BootDiskConfig", "description": "Optional. Boot disk configuration." }, "acceleratorConfig": { "$ref": "AcceleratorConfig", "description": "The AccleratorConfig for the TPU Node." }, "cidrBlock": { "description": "The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block.", "type": "string" }, "health": { "type": "string", "enumDescriptions": [ "Health status is unknown: not initialized or failed to retrieve.", "The resource is healthy.", "The resource is unresponsive.", "The in-guest ML stack is unhealthy.", "The node is under maintenance/priority boost caused rescheduling and will resume running once rescheduled." ], "description": "The health status of the TPU node.", "enum": [ "HEALTH_UNSPECIFIED", "HEALTHY", "TIMEOUT", "UNHEALTHY_TENSORFLOW", "UNHEALTHY_MAINTENANCE" ] }, "schedulingConfig": { "description": "The scheduling options for this node.", "$ref": "SchedulingConfig" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script" } }, "id": "Node", "type": "object", "description": "A TPU instance." }, "ListRuntimeVersionsResponse": { "properties": { "nextPageToken": { "type": "string", "description": "The next page token or empty if none." }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." }, "runtimeVersions": { "description": "The listed nodes.", "type": "array", "items": { "$ref": "RuntimeVersion" } } }, "description": "Response for ListRuntimeVersions.", "type": "object", "id": "ListRuntimeVersionsResponse" }, "GenerateServiceIdentityResponse": { "description": "Response for GenerateServiceIdentity.", "properties": { "identity": { "description": "ServiceIdentity that was created or retrieved.", "$ref": "ServiceIdentity" } }, "id": "GenerateServiceIdentityResponse", "type": "object" }, "AcceleratorType": { "properties": { "acceleratorConfigs": { "type": "array", "items": { "$ref": "AcceleratorConfig" }, "description": "The accelerator config." }, "name": { "type": "string", "description": "The resource name." }, "type": { "description": "The accelerator type.", "type": "string" } }, "type": "object", "description": "A accelerator type that a Node can be configured with.", "id": "AcceleratorType" } }, "revision": "20260127", "title": "Cloud TPU API", "kind": "discovery#restDescription", "baseUrl": "https://tpu.googleapis.com/" }