{
"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."
}
}
}
},
"basePath": "",
"baseUrl": "https://tpu.googleapis.com/",
"batchPath": "batch",
"canonicalName": "TPU",
"description": "TPU API provides customers with access to Google TPU technology.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/tpu/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "tpu:v2alpha1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://tpu.mtls.googleapis.com/",
"name": "tpu",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"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",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"locations": {
"methods": {
"generateServiceIdentity": {
"description": "Generates the Cloud TPU service identity for the project.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}:generateServiceIdentity",
"httpMethod": "POST",
"id": "tpu.projects.locations.generateServiceIdentity",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+parent}:generateServiceIdentity",
"request": {
"$ref": "GenerateServiceIdentityRequest"
},
"response": {
"$ref": "GenerateServiceIdentityResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets information about a location.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}",
"httpMethod": "GET",
"id": "tpu.projects.locations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name for the location.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+name}",
"response": {
"$ref": "Location"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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.",
"flatPath": "v2alpha1/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "tpu.projects.locations.list",
"parameterOrder": [
"name"
],
"parameters": {
"extraLocationTypes": {
"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
"location": "query",
"repeated": true,
"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).",
"location": "query",
"type": "string"
},
"name": {
"description": "The resource that owns the locations collection, if applicable.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"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"
}
},
"path": "v2alpha1/{+name}/locations",
"response": {
"$ref": "ListLocationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"acceleratorTypes": {
"methods": {
"get": {
"description": "Gets AcceleratorType.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/acceleratorTypes/{acceleratorTypesId}",
"httpMethod": "GET",
"id": "tpu.projects.locations.acceleratorTypes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/acceleratorTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+name}",
"response": {
"$ref": "AcceleratorType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists accelerator types supported by this API.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/acceleratorTypes",
"httpMethod": "GET",
"id": "tpu.projects.locations.acceleratorTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "List filter.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Sort results.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of items to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+parent}/acceleratorTypes",
"response": {
"$ref": "ListAcceleratorTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"nodes": {
"methods": {
"create": {
"description": "Creates a node.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/nodes",
"httpMethod": "POST",
"id": "tpu.projects.locations.nodes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"nodeId": {
"description": "The unqualified resource name.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Idempotent request UUID.",
"location": "query",
"type": "string"
}
},
"path": "v2alpha1/{+parent}/nodes",
"request": {
"$ref": "Node"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a node.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}",
"httpMethod": "DELETE",
"id": "tpu.projects.locations.nodes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Idempotent request UUID.",
"location": "query",
"type": "string"
}
},
"path": "v2alpha1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the details of a node.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}",
"httpMethod": "GET",
"id": "tpu.projects.locations.nodes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+name}",
"response": {
"$ref": "Node"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getGuestAttributes": {
"description": "Retrieves the guest attributes for the node.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:getGuestAttributes",
"httpMethod": "POST",
"id": "tpu.projects.locations.nodes.getGuestAttributes",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+name}:getGuestAttributes",
"request": {
"$ref": "GetGuestAttributesRequest"
},
"response": {
"$ref": "GetGuestAttributesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists nodes.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/nodes",
"httpMethod": "GET",
"id": "tpu.projects.locations.nodes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of items to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+parent}/nodes",
"response": {
"$ref": "ListNodesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the configurations of a node.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}",
"httpMethod": "PATCH",
"id": "tpu.projects.locations.nodes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. Immutable. The name of the TPU.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. Mask of fields from Node to update. Supported fields: [description, tags, labels, metadata, network_config.enable_external_ips].",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2alpha1/{+name}",
"request": {
"$ref": "Node"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"performMaintenance": {
"description": "Perform manual maintenance on a node.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:performMaintenance",
"httpMethod": "POST",
"id": "tpu.projects.locations.nodes.performMaintenance",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+name}:performMaintenance",
"request": {
"$ref": "PerformMaintenanceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"simulateMaintenanceEvent": {
"description": "Simulates a maintenance event.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:simulateMaintenanceEvent",
"httpMethod": "POST",
"id": "tpu.projects.locations.nodes.simulateMaintenanceEvent",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+name}:simulateMaintenanceEvent",
"request": {
"$ref": "SimulateMaintenanceEventRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"start": {
"description": "Starts a node.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:start",
"httpMethod": "POST",
"id": "tpu.projects.locations.nodes.start",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+name}:start",
"request": {
"$ref": "StartNodeRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"stop": {
"description": "Stops a node. This operation is only available with single TPU nodes.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:stop",
"httpMethod": "POST",
"id": "tpu.projects.locations.nodes.stop",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+name}:stop",
"request": {
"$ref": "StopNodeRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"operations": {
"methods": {
"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`.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "tpu.projects.locations.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+name}:cancel",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"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`.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "tpu.projects.locations.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "tpu.projects.locations.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "tpu.projects.locations.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
},
"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.",
"location": "query",
"type": "boolean"
}
},
"path": "v2alpha1/{+name}/operations",
"response": {
"$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"queuedResources": {
"methods": {
"create": {
"description": "Creates a QueuedResource TPU instance.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/queuedResources",
"httpMethod": "POST",
"id": "tpu.projects.locations.queuedResources.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"queuedResourceId": {
"description": "The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format.",
"location": "query",
"type": "string"
},
"requestId": {
"description": "Idempotent request UUID.",
"location": "query",
"type": "string"
}
},
"path": "v2alpha1/{+parent}/queuedResources",
"request": {
"$ref": "QueuedResource"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a QueuedResource TPU instance.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/queuedResources/{queuedResourcesId}",
"httpMethod": "DELETE",
"id": "tpu.projects.locations.queuedResources.delete",
"parameterOrder": [
"name"
],
"parameters": {
"force": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. The resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/queuedResources/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Idempotent request UUID.",
"location": "query",
"type": "string"
}
},
"path": "v2alpha1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of a queued resource.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/queuedResources/{queuedResourcesId}",
"httpMethod": "GET",
"id": "tpu.projects.locations.queuedResources.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/queuedResources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+name}",
"response": {
"$ref": "QueuedResource"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getMaintenanceInfo": {
"description": "Gets the maintenance info for a queued resource.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/queuedResources/{queuedResourcesId}:getMaintenanceInfo",
"httpMethod": "GET",
"id": "tpu.projects.locations.queuedResources.getMaintenanceInfo",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The QueuedResource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/queuedResources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+name}:getMaintenanceInfo",
"response": {
"$ref": "GetMaintenanceInfoResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists queued resources.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/queuedResources",
"httpMethod": "GET",
"id": "tpu.projects.locations.queuedResources.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of items to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+parent}/queuedResources",
"response": {
"$ref": "ListQueuedResourcesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"performMaintenanceQueuedResource": {
"description": "Perform manual maintenance on specific nodes of a QueuedResource.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/queuedResources/{queuedResourcesId}:performMaintenanceQueuedResource",
"httpMethod": "POST",
"id": "tpu.projects.locations.queuedResources.performMaintenanceQueuedResource",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the QueuedResource which holds the nodes to perform maintenance on.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/queuedResources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+name}:performMaintenanceQueuedResource",
"request": {
"$ref": "PerformMaintenanceQueuedResourceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"reset": {
"description": "Resets a QueuedResource TPU instance",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/queuedResources/{queuedResourcesId}:reset",
"httpMethod": "POST",
"id": "tpu.projects.locations.queuedResources.reset",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the queued resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/queuedResources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+name}:reset",
"request": {
"$ref": "ResetQueuedResourceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"reservations": {
"methods": {
"list": {
"description": "Retrieves the reservations for the given project in the given location.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/reservations",
"httpMethod": "GET",
"id": "tpu.projects.locations.reservations.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of items to return. Defaults to 0 if not specified, which means no limit.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent for reservations.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+parent}/reservations",
"response": {
"$ref": "ListReservationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"runtimeVersions": {
"methods": {
"get": {
"description": "Gets a runtime version.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/runtimeVersions/{runtimeVersionsId}",
"httpMethod": "GET",
"id": "tpu.projects.locations.runtimeVersions.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/runtimeVersions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+name}",
"response": {
"$ref": "RuntimeVersion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists runtime versions supported by this API.",
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/runtimeVersions",
"httpMethod": "GET",
"id": "tpu.projects.locations.runtimeVersions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "List filter.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Sort results.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of items to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha1/{+parent}/runtimeVersions",
"response": {
"$ref": "ListRuntimeVersionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
},
"revision": "20260127",
"rootUrl": "https://tpu.googleapis.com/",
"schemas": {
"AcceleratorConfig": {
"description": "A TPU accelerator configuration.",
"id": "AcceleratorConfig",
"properties": {
"topology": {
"description": "Required. Topology of TPU in chips.",
"type": "string"
},
"type": {
"description": "Required. Type of TPU.",
"enum": [
"TYPE_UNSPECIFIED",
"V2",
"V3",
"V4",
"V5LITE_POD",
"V5P",
"V6E"
],
"enumDescriptions": [
"Unspecified version.",
"TPU v2.",
"TPU v3.",
"TPU v4.",
"TPU v5lite pod.",
"TPU v5.",
"TPU v6e."
],
"type": "string"
}
},
"type": "object"
},
"AcceleratorType": {
"description": "A accelerator type that a Node can be configured with.",
"id": "AcceleratorType",
"properties": {
"acceleratorConfigs": {
"description": "The accelerator config.",
"items": {
"$ref": "AcceleratorConfig"
},
"type": "array"
},
"name": {
"description": "The resource name.",
"type": "string"
},
"type": {
"description": "The accelerator type.",
"type": "string"
}
},
"type": "object"
},
"AcceptedData": {
"description": "Further data for the accepted state.",
"id": "AcceptedData",
"properties": {},
"type": "object"
},
"AccessConfig": {
"description": "An access config attached to the TPU worker.",
"id": "AccessConfig",
"properties": {
"externalIp": {
"description": "Output only. An external IP address associated with the TPU worker.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ActiveData": {
"description": "Further data for the active state.",
"id": "ActiveData",
"properties": {},
"type": "object"
},
"AttachedDisk": {
"description": "A node-attached disk resource.",
"id": "AttachedDisk",
"properties": {
"mode": {
"description": "The mode in which to attach this disk. If not specified, the default is READ_WRITE mode. Only applicable to data_disks.",
"enum": [
"DISK_MODE_UNSPECIFIED",
"READ_WRITE",
"READ_ONLY"
],
"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."
],
"type": "string"
},
"sourceDisk": {
"description": "Specifies the full path to an existing disk. For example: \"projects/my-project/zones/us-central1-c/disks/my-disk\".",
"type": "string"
},
"workerIds": {
"description": "Optional. The list of worker IDs this disk is attached to.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"BestEffort": {
"description": "BestEffort tier definition.",
"id": "BestEffort",
"properties": {},
"type": "object"
},
"BootDiskConfig": {
"description": "Boot disk configurations.",
"id": "BootDiskConfig",
"properties": {
"customerEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "Optional. Customer encryption key for boot disk."
},
"diskSizeGb": {
"description": "Optional. Size of the boot disk in GB. It must be larger than or equal to the size of the image.",
"format": "int64",
"type": "string"
},
"enableConfidentialCompute": {
"description": "Optional. Whether the boot disk will be created with confidential compute mode.",
"type": "boolean"
},
"provisionedIops": {
"description": "Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. To learn more about IOPS, see [Provisioning persistent disk performance](https://cloud.google.com/compute/docs/disks/performance#provisioned-iops).",
"format": "int64",
"type": "string"
},
"provisionedThroughput": {
"description": "Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle.",
"format": "int64",
"type": "string"
},
"sourceImage": {
"description": "Optional. Image from which boot disk is to be created. If not specified, the default image for the runtime version will be used. Example: `projects/$PROJECT_ID/global/images/$IMAGE_NAME`.",
"type": "string"
},
"storagePool": {
"description": "Optional. The storage pool in which the boot disk is created. You can provide this as a partial or full URL to the resource.",
"type": "string"
}
},
"type": "object"
},
"CreatingData": {
"description": "Further data for the creating state.",
"id": "CreatingData",
"properties": {},
"type": "object"
},
"CustomerEncryptionKey": {
"description": "Customer's encryption key.",
"id": "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"
},
"DeletingData": {
"description": "Further data for the deleting state.",
"id": "DeletingData",
"properties": {},
"type": "object"
},
"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); }",
"id": "Empty",
"properties": {},
"type": "object"
},
"FailedData": {
"description": "Further data for the failed state.",
"id": "FailedData",
"properties": {
"error": {
"$ref": "Status",
"description": "The error that caused the queued resource to enter the FAILED state."
}
},
"type": "object"
},
"GenerateServiceIdentityRequest": {
"description": "Request for GenerateServiceIdentity.",
"id": "GenerateServiceIdentityRequest",
"properties": {},
"type": "object"
},
"GenerateServiceIdentityResponse": {
"description": "Response for GenerateServiceIdentity.",
"id": "GenerateServiceIdentityResponse",
"properties": {
"identity": {
"$ref": "ServiceIdentity",
"description": "ServiceIdentity that was created or retrieved."
}
},
"type": "object"
},
"GetGuestAttributesRequest": {
"description": "Request for GetGuestAttributes.",
"id": "GetGuestAttributesRequest",
"properties": {
"queryPath": {
"description": "The guest attributes path to be queried.",
"type": "string"
},
"workerIds": {
"description": "The 0-based worker ID. If it is empty, all workers' GuestAttributes will be returned.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GetGuestAttributesResponse": {
"description": "Response for GetGuestAttributes.",
"id": "GetGuestAttributesResponse",
"properties": {
"guestAttributes": {
"description": "The guest attributes for the TPU workers.",
"items": {
"$ref": "GuestAttributes"
},
"type": "array"
}
},
"type": "object"
},
"GetMaintenanceInfoResponse": {
"description": "Response for GetMaintenanceInfo.",
"id": "GetMaintenanceInfoResponse",
"properties": {
"nodeUpcomingMaintenances": {
"description": "The list of upcoming maintenance entries.",
"items": {
"$ref": "NodeUpcomingMaintenanceInfo"
},
"type": "array"
}
},
"type": "object"
},
"Guaranteed": {
"description": "Guaranteed tier definition.",
"id": "Guaranteed",
"properties": {
"minDuration": {
"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.",
"format": "google-duration",
"type": "string"
},
"reserved": {
"description": "Optional. Specifies the request should be scheduled on reserved capacity.",
"type": "boolean"
}
},
"type": "object"
},
"GuestAttributes": {
"description": "A guest attributes.",
"id": "GuestAttributes",
"properties": {
"queryPath": {
"description": "The path to be queried. This can be the default namespace ('/') or a nested namespace ('/\\/') or a specified key ('/\\/\\')",
"type": "string"
},
"queryValue": {
"$ref": "GuestAttributesValue",
"description": "The value of the requested queried path."
}
},
"type": "object"
},
"GuestAttributesEntry": {
"description": "A guest attributes namespace/key/value entry.",
"id": "GuestAttributesEntry",
"properties": {
"key": {
"description": "Key for the guest attribute entry.",
"type": "string"
},
"namespace": {
"description": "Namespace for the guest attribute entry.",
"type": "string"
},
"value": {
"description": "Value for the guest attribute entry.",
"type": "string"
}
},
"type": "object"
},
"GuestAttributesValue": {
"description": "Array of guest attribute namespace/key/value tuples.",
"id": "GuestAttributesValue",
"properties": {
"items": {
"description": "The list of guest attributes entries.",
"items": {
"$ref": "GuestAttributesEntry"
},
"type": "array"
}
},
"type": "object"
},
"Interval": {
"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",
"properties": {
"endTime": {
"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.",
"format": "google-datetime",
"type": "string"
},
"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.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"ListAcceleratorTypesResponse": {
"description": "Response for ListAcceleratorTypes.",
"id": "ListAcceleratorTypesResponse",
"properties": {
"acceleratorTypes": {
"description": "The listed nodes.",
"items": {
"$ref": "AcceleratorType"
},
"type": "array"
},
"nextPageToken": {
"description": "The next page token or empty if none.",
"type": "string"
},
"unreachable": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"id": "ListLocationsResponse",
"properties": {
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"items": {
"$ref": "Location"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
"ListNodesResponse": {
"description": "Response for ListNodes.",
"id": "ListNodesResponse",
"properties": {
"nextPageToken": {
"description": "The next page token or empty if none.",
"type": "string"
},
"nodes": {
"description": "The listed nodes.",
"items": {
"$ref": "Node"
},
"type": "array"
},
"unreachable": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "ListOperationsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
},
"unreachable": {
"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"
},
"type": "array"
}
},
"type": "object"
},
"ListQueuedResourcesResponse": {
"description": "Response for ListQueuedResources.",
"id": "ListQueuedResourcesResponse",
"properties": {
"nextPageToken": {
"description": "The next page token or empty if none.",
"type": "string"
},
"queuedResources": {
"description": "The listed queued resources.",
"items": {
"$ref": "QueuedResource"
},
"type": "array"
},
"unreachable": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListReservationsResponse": {
"description": "Response for ListReservations.",
"id": "ListReservationsResponse",
"properties": {
"nextPageToken": {
"description": "The next page token or empty if none.",
"type": "string"
},
"reservations": {
"description": "The listed reservations.",
"items": {
"$ref": "Reservation"
},
"type": "array"
}
},
"type": "object"
},
"ListRuntimeVersionsResponse": {
"description": "Response for ListRuntimeVersions.",
"id": "ListRuntimeVersionsResponse",
"properties": {
"nextPageToken": {
"description": "The next page token or empty if none.",
"type": "string"
},
"runtimeVersions": {
"description": "The listed nodes.",
"items": {
"$ref": "RuntimeVersion"
},
"type": "array"
},
"unreachable": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Location": {
"description": "A resource that represents a Google Cloud location.",
"id": "Location",
"properties": {
"displayName": {
"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}",
"type": "object"
},
"locationId": {
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
"type": "string"
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata. For example the available capacity at the given location.",
"type": "object"
},
"name": {
"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
}
},
"type": "object"
},
"MultiNodeParams": {
"description": "Parameters to specify for multi-node QueuedResource requests. This field must be populated in case of multi-node requests instead of node_id. It's an error to specify both node_id and multi_node_params.",
"id": "MultiNodeParams",
"properties": {
"nodeCount": {
"description": "Required. Number of nodes with this spec. The system will attempt to provison \"node_count\" nodes as part of the request. This needs to be > 1.",
"format": "int32",
"type": "integer"
},
"nodeIdPrefix": {
"description": "Prefix of node_ids in case of multi-node 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.",
"type": "string"
},
"workloadType": {
"description": "Optional. The workload type for the multi-node request.",
"enum": [
"WORKLOAD_TYPE_UNSPECIFIED",
"THROUGHPUT_OPTIMIZED",
"AVAILABILITY_OPTIMIZED"
],
"enumDescriptions": [
"Not specified.",
"All of the nodes are available most of the time. Recommended for training workloads.",
"Most of the nodes are available all of the time. Recommended for serving workloads."
],
"type": "string"
}
},
"type": "object"
},
"NetworkConfig": {
"description": "Network related configurations.",
"id": "NetworkConfig",
"properties": {
"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"
},
"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"
},
"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"
},
"queueCount": {
"description": "Optional. Specifies networking queue count for TPU VM instance's network interface.",
"format": "int32",
"type": "integer"
},
"subnetwork": {
"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.",
"type": "string"
}
},
"type": "object"
},
"NetworkEndpoint": {
"description": "A network endpoint over which a TPU worker can be reached.",
"id": "NetworkEndpoint",
"properties": {
"accessConfig": {
"$ref": "AccessConfig",
"description": "The access config for the TPU worker."
},
"ipAddress": {
"description": "The internal IP address of this network endpoint.",
"type": "string"
},
"port": {
"description": "The port of this network endpoint.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"Node": {
"description": "A TPU instance.",
"id": "Node",
"properties": {
"acceleratorConfig": {
"$ref": "AcceleratorConfig",
"description": "The AccleratorConfig for the TPU Node."
},
"acceleratorType": {
"description": "The type of hardware accelerators associated with this node.",
"type": "string"
},
"apiVersion": {
"description": "Output only. The API version that created this Node.",
"enum": [
"API_VERSION_UNSPECIFIED",
"V1_ALPHA1",
"V1",
"V2_ALPHA1"
],
"enumDescriptions": [
"API version is unknown.",
"TPU API V1Alpha1 version.",
"TPU API V1 version.",
"TPU API V2Alpha1 version."
],
"readOnly": true,
"type": "string"
},
"autocheckpointEnabled": {
"description": "Optional. Whether Autocheckpoint is enabled.",
"type": "boolean"
},
"bootDiskConfig": {
"$ref": "BootDiskConfig",
"description": "Optional. Boot disk configuration."
},
"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"
},
"createTime": {
"description": "Output only. The time when the node was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"dataDisks": {
"description": "The additional data disks for the Node.",
"items": {
"$ref": "AttachedDisk"
},
"type": "array"
},
"description": {
"description": "The user-supplied description of the TPU. Maximum of 512 characters.",
"type": "string"
},
"health": {
"description": "The health status of the TPU node.",
"enum": [
"HEALTH_UNSPECIFIED",
"HEALTHY",
"TIMEOUT",
"UNHEALTHY_TENSORFLOW",
"UNHEALTHY_MAINTENANCE"
],
"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."
],
"type": "string"
},
"healthDescription": {
"description": "Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Output only. The unique identifier for the TPU Node.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Resource labels to represent user-provided metadata.",
"type": "object"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script",
"type": "object"
},
"multisliceNode": {
"description": "Output only. Whether the Node belongs to a Multislice group.",
"readOnly": true,
"type": "boolean"
},
"name": {
"description": "Output only. Immutable. The name of the TPU.",
"readOnly": true,
"type": "string"
},
"networkConfig": {
"$ref": "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."
},
"networkConfigs": {
"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.",
"items": {
"$ref": "NetworkConfig"
},
"type": "array"
},
"networkEndpoints": {
"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"
},
"readOnly": true,
"type": "array"
},
"queuedResource": {
"description": "Output only. The qualified name of the QueuedResource that requested this Node.",
"readOnly": true,
"type": "string"
},
"runtimeVersion": {
"description": "Required. The runtime version running in the Node.",
"type": "string"
},
"schedulingConfig": {
"$ref": "SchedulingConfig",
"description": "The scheduling options for this node."
},
"serviceAccount": {
"$ref": "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."
},
"shieldedInstanceConfig": {
"$ref": "ShieldedInstanceConfig",
"description": "Shielded Instance options."
},
"state": {
"description": "Output only. The current state for the TPU Node.",
"enum": [
"STATE_UNSPECIFIED",
"CREATING",
"READY",
"RESTARTING",
"REIMAGING",
"DELETING",
"REPAIRING",
"STOPPED",
"STOPPING",
"STARTING",
"PREEMPTED",
"TERMINATED",
"HIDING",
"HIDDEN",
"UNHIDING",
"UNKNOWN"
],
"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."
],
"readOnly": true,
"type": "string"
},
"symptoms": {
"description": "Output only. The Symptoms that have occurred to the TPU Node.",
"items": {
"$ref": "Symptom"
},
"readOnly": true,
"type": "array"
},
"tags": {
"description": "Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.",
"items": {
"type": "string"
},
"type": "array"
},
"upcomingMaintenance": {
"$ref": "UpcomingMaintenance",
"description": "Output only. Upcoming maintenance on this TPU node.",
"readOnly": true
}
},
"type": "object"
},
"NodeSpec": {
"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.",
"id": "NodeSpec",
"properties": {
"multiNodeParams": {
"$ref": "MultiNodeParams",
"description": "Optional. Fields to specify in case of multi-node request."
},
"node": {
"$ref": "Node",
"description": "Required. The node."
},
"nodeId": {
"description": "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 multi-node requests, multi_node_params must be populated instead. It's an error to specify both node_id and multi_node_params.",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name.",
"type": "string"
}
},
"type": "object"
},
"NodeUpcomingMaintenanceInfo": {
"description": "A tuple containing node name / ID and maintenance info.",
"id": "NodeUpcomingMaintenanceInfo",
"properties": {
"nodeName": {
"description": "Unqualified node name.",
"type": "string"
},
"nodeUid": {
"description": "UID of this node.",
"format": "int64",
"type": "string"
},
"upcomingMaintenance": {
"$ref": "UpcomingMaintenance",
"description": "Upcoming maintenance info for this node."
}
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "Operation",
"properties": {
"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": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"OperationMetadata": {
"description": "Metadata describing an Operation",
"id": "OperationMetadata",
"properties": {
"apiVersion": {
"description": "API version.",
"type": "string"
},
"cancelRequested": {
"description": "Specifies if cancellation was requested for the operation.",
"type": "boolean"
},
"createTime": {
"description": "The time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"endTime": {
"description": "The time the operation finished running.",
"format": "google-datetime",
"type": "string"
},
"statusDetail": {
"description": "Human-readable status of the operation, if any.",
"type": "string"
},
"target": {
"description": "Target of the operation - for example projects/project-1/connectivityTests/test-1",
"type": "string"
},
"verb": {
"description": "Name of the verb executed by the operation.",
"type": "string"
}
},
"type": "object"
},
"PerformMaintenanceQueuedResourceRequest": {
"description": "Request for PerformMaintenanceQueuedResource.",
"id": "PerformMaintenanceQueuedResourceRequest",
"properties": {
"nodeNames": {
"description": "The names of the nodes to perform maintenance on.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"PerformMaintenanceRequest": {
"description": "Request for PerformMaintenance.",
"id": "PerformMaintenanceRequest",
"properties": {},
"type": "object"
},
"ProvisioningData": {
"description": "Further data for the provisioning state.",
"id": "ProvisioningData",
"properties": {},
"type": "object"
},
"QueuedResource": {
"description": "A QueuedResource represents a request for resources that will be placed in a queue and fulfilled when the necessary resources are available.",
"id": "QueuedResource",
"properties": {
"bestEffort": {
"$ref": "BestEffort",
"description": "The BestEffort tier."
},
"createTime": {
"description": "Output only. The time when the QueuedResource was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"guaranteed": {
"$ref": "Guaranteed",
"description": "The Guaranteed tier."
},
"name": {
"description": "Output only. Immutable. The name of the QueuedResource.",
"readOnly": true,
"type": "string"
},
"provisioningModel": {
"description": "Optional. The provisioning model for the resource.",
"enum": [
"PROVISIONING_MODEL_UNSPECIFIED",
"STANDARD",
"SPOT",
"RESERVATION_BOUND",
"FLEX_START"
],
"enumDescriptions": [
"Provisioning model is unknown.",
"Standard provisioning with user controlled runtime.",
"Spot provisioning with no guaranteed runtime.",
"Reservation provisioning with runtime bound to the lifetime of the consumed reservation.",
"Provisioning with DWS Flex Start with max run duration."
],
"type": "string"
},
"queueingPolicy": {
"$ref": "QueueingPolicy",
"description": "The queueing policy of the QueuedRequest."
},
"reservationName": {
"description": "Name of the reservation in which the resource should be provisioned. Format: projects/{project}/locations/{zone}/reservations/{reservation}",
"type": "string"
},
"runDuration": {
"$ref": "RunDuration",
"description": "Optional. The duration of the requested resource."
},
"spot": {
"$ref": "Spot",
"description": "Optional. The Spot tier."
},
"state": {
"$ref": "QueuedResourceState",
"description": "Output only. State of the QueuedResource request.",
"readOnly": true
},
"tpu": {
"$ref": "Tpu",
"description": "Defines a TPU resource."
}
},
"type": "object"
},
"QueuedResourceState": {
"description": "QueuedResourceState defines the details of the QueuedResource request.",
"id": "QueuedResourceState",
"properties": {
"acceptedData": {
"$ref": "AcceptedData",
"description": "Further data for the accepted state."
},
"activeData": {
"$ref": "ActiveData",
"description": "Further data for the active state."
},
"creatingData": {
"$ref": "CreatingData",
"description": "Further data for the creating state."
},
"deletingData": {
"$ref": "DeletingData",
"description": "Further data for the deleting state."
},
"failedData": {
"$ref": "FailedData",
"description": "Further data for the failed state."
},
"provisioningData": {
"$ref": "ProvisioningData",
"description": "Further data for the provisioning state."
},
"state": {
"description": "State of the QueuedResource request.",
"enum": [
"STATE_UNSPECIFIED",
"CREATING",
"ACCEPTED",
"PROVISIONING",
"FAILED",
"DELETING",
"ACTIVE",
"SUSPENDING",
"SUSPENDED",
"WAITING_FOR_RESOURCES"
],
"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)."
],
"type": "string"
},
"stateInitiator": {
"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.",
"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."
],
"readOnly": true,
"type": "string"
},
"suspendedData": {
"$ref": "SuspendedData",
"description": "Further data for the suspended state."
},
"suspendingData": {
"$ref": "SuspendingData",
"description": "Further data for the suspending state."
}
},
"type": "object"
},
"QueueingPolicy": {
"description": "Defines the policy of the QueuedRequest.",
"id": "QueueingPolicy",
"properties": {
"validAfterDuration": {
"description": "A relative time after which resources may be created.",
"format": "google-duration",
"type": "string"
},
"validAfterTime": {
"description": "An absolute time at which resources may be created.",
"format": "google-datetime",
"type": "string"
},
"validInterval": {
"$ref": "Interval",
"description": "An absolute time interval within which resources may be created."
},
"validUntilDuration": {
"description": "A relative time after which resources should not be created. If the request cannot be fulfilled by this time the request will be failed.",
"format": "google-duration",
"type": "string"
},
"validUntilTime": {
"description": "An absolute time after which resources should not be created. If the request cannot be fulfilled by this time the request will be failed.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"Reservation": {
"description": "A reservation describes the amount of a resource 'allotted' for a defined period of time.",
"id": "Reservation",
"properties": {
"name": {
"description": "The reservation name with the format: projects/{projectID}/locations/{location}/reservations/{reservationID}",
"type": "string"
},
"standard": {
"$ref": "Standard",
"description": "A standard reservation."
},
"state": {
"description": "Output only. The state of the Reservation.",
"enum": [
"STATE_UNSPECIFIED",
"APPROVED",
"PROVISIONING",
"ACTIVE",
"DEPROVISIONING",
"EXPIRED",
"FAILED"
],
"enumDescriptions": [
"The Reservation state is unspecified.",
"The Reservation has been approved.",
"The Reservation is being provisioned.",
"The Reservation is active.",
"The Reservation is being deprovisioned.",
"The Reservation is past its end date.",
"The Reservation encountered a failure during mutation."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ResetQueuedResourceRequest": {
"description": "Request for ResetQueuedResource.",
"id": "ResetQueuedResourceRequest",
"properties": {},
"type": "object"
},
"RunDuration": {
"description": "Defines the maximum lifetime of the requested resource.",
"id": "RunDuration",
"properties": {
"maxRunDuration": {
"description": "The maximum duration of the requested resource.",
"format": "google-duration",
"type": "string"
},
"terminationTime": {
"description": "The time at which the requested resource will be terminated.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"RuntimeVersion": {
"description": "A runtime version that a Node can be configured with.",
"id": "RuntimeVersion",
"properties": {
"name": {
"description": "The resource name.",
"type": "string"
},
"version": {
"description": "The runtime version.",
"type": "string"
}
},
"type": "object"
},
"SchedulingConfig": {
"description": "Sets the scheduling options for this node.",
"id": "SchedulingConfig",
"properties": {
"preemptible": {
"description": "Defines whether the node is preemptible.",
"type": "boolean"
},
"provisioningModel": {
"description": "Optional. Defines the provisioning model for the node.",
"enum": [
"PROVISIONING_MODEL_UNSPECIFIED",
"STANDARD",
"SPOT",
"RESERVATION_BOUND"
],
"enumDescriptions": [
"Provisioning model is unknown.",
"Standard provisioning with user controlled runtime.",
"Spot provisioning with no guaranteed runtime.",
"Reservation provisioning with runtime bound to the lifetime of the consumed reservation."
],
"type": "string"
},
"reservationName": {
"description": "Optional. Name of the reservation in which the node should be provisioned.",
"type": "string"
},
"reserved": {
"description": "Whether the node is created under a reservation.",
"type": "boolean"
},
"spot": {
"description": "Optional. Defines whether the node is Spot VM.",
"type": "boolean"
},
"terminationTimestamp": {
"description": "Output only. The time at which the node will be terminated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ServiceAccount": {
"description": "A service account.",
"id": "ServiceAccount",
"properties": {
"email": {
"description": "Email address of the service account. If empty, default Compute service account will be used.",
"type": "string"
},
"scope": {
"description": "The list of scopes to be made available for this service account. If empty, access to all Cloud APIs will be allowed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ServiceIdentity": {
"description": "The per-product per-project service identity for Cloud TPU service.",
"id": "ServiceIdentity",
"properties": {
"email": {
"description": "The email address of the service identity.",
"type": "string"
}
},
"type": "object"
},
"ShieldedInstanceConfig": {
"description": "A set of Shielded Instance options.",
"id": "ShieldedInstanceConfig",
"properties": {
"enableSecureBoot": {
"description": "Defines whether the instance has Secure Boot enabled.",
"type": "boolean"
}
},
"type": "object"
},
"SimulateMaintenanceEventRequest": {
"description": "Request for SimulateMaintenanceEvent.",
"id": "SimulateMaintenanceEventRequest",
"properties": {
"workerIds": {
"description": "The 0-based worker ID. If it is empty, worker ID 0 will be selected for maintenance event simulation. A maintenance event will only be fired on the first specified worker ID. Future implementations may support firing on multiple workers.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Spot": {
"description": "Spot tier definition.",
"id": "Spot",
"properties": {},
"type": "object"
},
"Standard": {
"description": "Details of a standard reservation.",
"id": "Standard",
"properties": {
"capacityUnits": {
"description": "Capacity units this reservation is measured in.",
"enum": [
"CAPACITY_UNITS_UNSPECIFIED",
"CORES",
"CHIPS"
],
"enumDescriptions": [
"The capacity units is not known/set.",
"The capacity unit is set to CORES.",
"The capacity unit is set to CHIPS."
],
"type": "string"
},
"interval": {
"$ref": "Interval",
"description": "The start and end time of the reservation."
},
"resourceType": {
"description": "The resource type of the reservation.",
"type": "string"
},
"size": {
"description": "The size of the reservation, in the units specified in the 'capacity_units' field.",
"format": "int32",
"type": "integer"
},
"usage": {
"$ref": "Usage",
"description": "The current usage of the reservation."
}
},
"type": "object"
},
"StartNodeRequest": {
"description": "Request for StartNode.",
"id": "StartNodeRequest",
"properties": {},
"type": "object"
},
"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).",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"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"
}
},
"type": "object"
},
"StopNodeRequest": {
"description": "Request for StopNode.",
"id": "StopNodeRequest",
"properties": {},
"type": "object"
},
"SuspendedData": {
"description": "Further data for the suspended state.",
"id": "SuspendedData",
"properties": {},
"type": "object"
},
"SuspendingData": {
"description": "Further data for the suspending state.",
"id": "SuspendingData",
"properties": {},
"type": "object"
},
"Symptom": {
"description": "A Symptom instance.",
"id": "Symptom",
"properties": {
"createTime": {
"description": "Timestamp when the Symptom is created.",
"format": "google-datetime",
"type": "string"
},
"details": {
"description": "Detailed information of the current Symptom.",
"type": "string"
},
"symptomType": {
"description": "Type of the Symptom.",
"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."
],
"type": "string"
},
"workerId": {
"description": "A string used to uniquely distinguish a worker within a TPU node.",
"type": "string"
}
},
"type": "object"
},
"Tpu": {
"description": "Details of the TPU resource(s) being requested.",
"id": "Tpu",
"properties": {
"nodeSpec": {
"description": "The TPU node(s) being requested.",
"items": {
"$ref": "NodeSpec"
},
"type": "array"
}
},
"type": "object"
},
"UpcomingMaintenance": {
"description": "Upcoming Maintenance notification information.",
"id": "UpcomingMaintenance",
"properties": {
"canReschedule": {
"description": "Indicates if the maintenance can be customer triggered.",
"type": "boolean"
},
"latestWindowStartTime": {
"description": "The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.",
"type": "string"
},
"maintenanceStatus": {
"description": "The status of the maintenance.",
"enum": [
"UNKNOWN",
"PENDING",
"ONGOING"
],
"enumDescriptions": [
"Unknown maintenance status. Do not use this value.",
"There is pending maintenance.",
"There is ongoing maintenance on this VM."
],
"type": "string"
},
"type": {
"description": "Defines the type of maintenance.",
"enum": [
"UNKNOWN_TYPE",
"SCHEDULED",
"UNSCHEDULED"
],
"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"
},
"windowEndTime": {
"description": "The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.",
"type": "string"
},
"windowStartTime": {
"description": "The current start time of the maintenance window. This timestamp value is in RFC3339 text format.",
"type": "string"
}
},
"type": "object"
},
"Usage": {
"description": "Usage details of a reservation.",
"id": "Usage",
"properties": {
"total": {
"description": "The real-time value of usage within the reservation, with the unit specified in field capacity_units.",
"format": "int64",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Cloud TPU API",
"version": "v2alpha1",
"version_module": true
}