{ "version": "v2", "version_module": true, "canonicalName": "TPU", "schemas": { "QueuedResource": { "description": "A QueuedResource represents a request for resources that will be placed in a queue and fulfilled when the necessary resources are available.", "type": "object", "properties": { "queueingPolicy": { "$ref": "QueueingPolicy", "description": "Optional. The queueing policy of the QueuedRequest." }, "state": { "description": "Output only. State of the QueuedResource request.", "readOnly": true, "$ref": "QueuedResourceState" }, "spot": { "description": "Optional. The Spot tier.", "$ref": "Spot" }, "reservationName": { "type": "string", "description": "Optional. Name of the reservation in which the resource should be provisioned. Format: projects/{project}/locations/{zone}/reservations/{reservation}" }, "tpu": { "description": "Optional. Defines a TPU resource.", "$ref": "Tpu" }, "name": { "type": "string", "description": "Output only. Immutable. The name of the QueuedResource.", "readOnly": true }, "guaranteed": { "$ref": "Guaranteed", "description": "Optional. The Guaranteed tier" }, "createTime": { "description": "Output only. The time when the QueuedResource was created.", "readOnly": true, "format": "google-datetime", "type": "string" } }, "id": "QueuedResource" }, "ListRuntimeVersionsResponse": { "id": "ListRuntimeVersionsResponse", "description": "Response for ListRuntimeVersions.", "type": "object", "properties": { "runtimeVersions": { "items": { "$ref": "RuntimeVersion" }, "description": "The listed nodes.", "type": "array" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" }, "nextPageToken": { "description": "The next page token or empty if none.", "type": "string" } } }, "NetworkEndpoint": { "id": "NetworkEndpoint", "type": "object", "properties": { "port": { "type": "integer", "description": "The port of this network endpoint.", "format": "int32" }, "accessConfig": { "description": "The access config for the TPU worker.", "$ref": "AccessConfig" }, "ipAddress": { "type": "string", "description": "The internal IP address of this network endpoint." } }, "description": "A network endpoint over which a TPU worker can be reached." }, "Interval": { "id": "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.", "type": "object", "properties": { "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" }, "startTime": { "type": "string", "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" } } }, "AcceleratorConfig": { "id": "AcceleratorConfig", "type": "object", "properties": { "topology": { "description": "Required. Topology of TPU in chips.", "type": "string" }, "type": { "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": "string", "description": "Required. Type of TPU." } }, "description": "A TPU accelerator configuration." }, "AccessConfig": { "id": "AccessConfig", "description": "An access config attached to the TPU worker.", "type": "object", "properties": { "externalIp": { "type": "string", "description": "Output only. An external IP address associated with the TPU worker.", "readOnly": true } } }, "ListAcceleratorTypesResponse": { "description": "Response for ListAcceleratorTypes.", "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "The next page token or empty if none." }, "unreachable": { "type": "array", "description": "Locations that could not be reached.", "items": { "type": "string" } }, "acceleratorTypes": { "items": { "$ref": "AcceleratorType" }, "description": "The listed nodes.", "type": "array" } }, "id": "ListAcceleratorTypesResponse" }, "Guaranteed": { "id": "Guaranteed", "type": "object", "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" } }, "description": "Guaranteed tier definition." }, "GuestAttributesValue": { "id": "GuestAttributesValue", "type": "object", "properties": { "items": { "items": { "$ref": "GuestAttributesEntry" }, "description": "The list of guest attributes entries.", "type": "array" } }, "description": "Array of guest attribute namespace/key/value tuples." }, "ListLocationsResponse": { "id": "ListLocationsResponse", "type": "object", "properties": { "locations": { "items": { "$ref": "Location" }, "description": "A list of locations that matches the specified filter in the request.", "type": "array" }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } }, "description": "The response message for Locations.ListLocations." }, "GetGuestAttributesRequest": { "type": "object", "properties": { "queryPath": { "description": "The guest attributes path to be queried.", "type": "string" }, "workerIds": { "items": { "type": "string" }, "type": "array", "description": "The 0-based worker ID. If it is empty, all workers' GuestAttributes will be returned." } }, "description": "Request for GetGuestAttributes.", "id": "GetGuestAttributesRequest" }, "NetworkConfig": { "id": "NetworkConfig", "description": "Network related configurations.", "type": "object", "properties": { "enableExternalIps": { "type": "boolean", "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." }, "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." }, "canIpForward": { "type": "boolean", "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." }, "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": { "type": "integer", "description": "Optional. Specifies networking queue count for TPU VM instance's network interface.", "format": "int32" } } }, "ListQueuedResourcesResponse": { "id": "ListQueuedResourcesResponse", "description": "Response for ListQueuedResources.", "type": "object", "properties": { "queuedResources": { "type": "array", "description": "The listed queued resources.", "items": { "$ref": "QueuedResource" } }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" }, "nextPageToken": { "type": "string", "description": "The next page token or empty if none." } } }, "QueueingPolicy": { "id": "QueueingPolicy", "type": "object", "properties": { "validAfterTime": { "description": "Optional. An absolute time after which resources may be created.", "format": "google-datetime", "type": "string" }, "validAfterDuration": { "type": "string", "description": "Optional. A relative time after which resources may be created.", "format": "google-duration" }, "validInterval": { "description": "Optional. An absolute time interval within which resources may be created.", "$ref": "Interval" }, "validUntilTime": { "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.", "format": "google-datetime", "type": "string" }, "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.", "format": "google-duration", "type": "string" } }, "description": "Defines the policy of the QueuedRequest." }, "SuspendedData": { "id": "SuspendedData", "description": "Further data for the suspended state.", "type": "object", "properties": {} }, "ShieldedInstanceConfig": { "type": "object", "properties": { "enableSecureBoot": { "description": "Defines whether the instance has Secure Boot enabled.", "type": "boolean" } }, "description": "A set of Shielded Instance options.", "id": "ShieldedInstanceConfig" }, "RuntimeVersion": { "id": "RuntimeVersion", "description": "A runtime version that a Node can be configured with.", "type": "object", "properties": { "version": { "type": "string", "description": "The runtime version." }, "name": { "type": "string", "description": "The resource name." } } }, "ProvisioningData": { "description": "Further data for the provisioning state.", "type": "object", "properties": {}, "id": "ProvisioningData" }, "Spot": { "type": "object", "properties": {}, "description": "Spot tier definition.", "id": "Spot" }, "NodeSpec": { "id": "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.", "type": "object", "properties": { "nodeId": { "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.", "type": "string" }, "parent": { "type": "string", "description": "Required. The parent resource name." }, "multisliceParams": { "$ref": "MultisliceParams", "description": "Optional. Fields to specify in case of multislice request." }, "node": { "description": "Required. The node.", "$ref": "Node" } } }, "Location": { "id": "Location", "description": "A resource that represents a Google Cloud location.", "type": "object", "properties": { "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "locationId": { "type": "string", "description": "The canonical id for this location. For example: `\"us-east1\"`." }, "metadata": { "type": "object", "description": "Service-specific metadata. For example the available capacity at the given location.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" } } }, "Operation": { "type": "object", "properties": { "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "response": { "type": "object", "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`.", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "metadata": { "type": "object", "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.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" } }, "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation" }, "Symptom": { "id": "Symptom", "type": "object", "properties": { "createTime": { "description": "Timestamp when the Symptom is created.", "format": "google-datetime", "type": "string" }, "details": { "type": "string", "description": "Detailed information of the current Symptom." }, "symptomType": { "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." ], "enum": [ "SYMPTOM_TYPE_UNSPECIFIED", "LOW_MEMORY", "OUT_OF_MEMORY", "EXECUTE_TIMED_OUT", "MESH_BUILD_FAIL", "HBM_OUT_OF_MEMORY", "PROJECT_ABUSE" ], "description": "Type of the Symptom.", "type": "string" }, "workerId": { "description": "A string used to uniquely distinguish a worker within a TPU node.", "type": "string" } }, "description": "A Symptom instance." }, "Empty": { "id": "Empty", "type": "object", "properties": {}, "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); }" }, "GuestAttributes": { "id": "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." }, "ListNodesResponse": { "id": "ListNodesResponse", "type": "object", "properties": { "unreachable": { "type": "array", "description": "Locations that could not be reached.", "items": { "type": "string" } }, "nextPageToken": { "description": "The next page token or empty if none.", "type": "string" }, "nodes": { "items": { "$ref": "Node" }, "description": "The listed nodes.", "type": "array" } }, "description": "Response for ListNodes." }, "ListOperationsResponse": { "type": "object", "properties": { "operations": { "type": "array", "description": "A list of operations that matches the specified filter in the request.", "items": { "$ref": "Operation" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "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.", "type": "array", "items": { "type": "string" } } }, "description": "The response message for Operations.ListOperations.", "id": "ListOperationsResponse" }, "ServiceIdentity": { "id": "ServiceIdentity", "description": "The per-product per-project service identity for Cloud TPU service.", "type": "object", "properties": { "email": { "description": "The email address of the service identity.", "type": "string" } } }, "SchedulingConfig": { "id": "SchedulingConfig", "description": "Sets the scheduling options for this node.", "type": "object", "properties": { "spot": { "description": "Optional. Defines whether the node is Spot VM.", "type": "boolean" }, "preemptible": { "type": "boolean", "description": "Defines whether the node is preemptible." }, "reserved": { "description": "Whether the node is created under a reservation.", "type": "boolean" } } }, "AttachedDisk": { "id": "AttachedDisk", "type": "object", "properties": { "sourceDisk": { "description": "Specifies the full path to an existing disk. For example: \"projects/my-project/zones/us-central1-c/disks/my-disk\".", "type": "string" }, "mode": { "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." ], "enum": [ "DISK_MODE_UNSPECIFIED", "READ_WRITE", "READ_ONLY" ], "type": "string", "description": "The mode in which to attach this disk. If not specified, the default is READ_WRITE mode. Only applicable to data_disks." } }, "description": "A node-attached disk resource. Next ID: 8;" }, "BootDiskConfig": { "description": "Sets the boot disk configuration for the TPU node.", "type": "object", "properties": { "customerEncryptionKey": { "description": "Optional. Customer encryption key for boot disk.", "$ref": "CustomerEncryptionKey" } }, "id": "BootDiskConfig" }, "QueuedResourceState": { "id": "QueuedResourceState", "description": "QueuedResourceState defines the details of the QueuedResource request.", "type": "object", "properties": { "acceptedData": { "description": "Output only. Further data for the accepted state.", "readOnly": true, "$ref": "AcceptedData" }, "suspendedData": { "$ref": "SuspendedData", "description": "Output only. Further data for the suspended state.", "readOnly": true }, "suspendingData": { "description": "Output only. Further data for the suspending state.", "readOnly": true, "$ref": "SuspendingData" }, "creatingData": { "description": "Output only. Further data for the creating state.", "readOnly": true, "$ref": "CreatingData" }, "provisioningData": { "description": "Output only. Further data for the provisioning state.", "readOnly": true, "$ref": "ProvisioningData" }, "stateInitiator": { "type": "string", "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.", "readOnly": true, "enumDescriptions": [ "The state initiator is unspecified.", "The current QueuedResource state was initiated by the user.", "The current QueuedResource state was initiated by the service." ], "enum": [ "STATE_INITIATOR_UNSPECIFIED", "USER", "SERVICE" ] }, "state": { "description": "Output only. State of the QueuedResource request.", "readOnly": true, "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)." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACCEPTED", "PROVISIONING", "FAILED", "DELETING", "ACTIVE", "SUSPENDING", "SUSPENDED", "WAITING_FOR_RESOURCES" ] }, "failedData": { "description": "Output only. Further data for the failed state.", "readOnly": true, "$ref": "FailedData" }, "deletingData": { "$ref": "DeletingData", "description": "Output only. Further data for the deleting state.", "readOnly": true }, "activeData": { "description": "Output only. Further data for the active state.", "readOnly": true, "$ref": "ActiveData" } } }, "AcceleratorType": { "id": "AcceleratorType", "type": "object", "properties": { "acceleratorConfigs": { "items": { "$ref": "AcceleratorConfig" }, "description": "The accelerator config.", "type": "array" }, "name": { "description": "The resource name.", "type": "string" }, "type": { "type": "string", "description": "The accelerator type." } }, "description": "A accelerator type that a Node can be configured with." }, "Node": { "id": "Node", "description": "A TPU instance.", "type": "object", "properties": { "state": { "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." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "RESTARTING", "REIMAGING", "DELETING", "REPAIRING", "STOPPED", "STOPPING", "STARTING", "PREEMPTED", "TERMINATED", "HIDING", "HIDDEN", "UNHIDING", "UNKNOWN" ], "type": "string", "description": "Output only. The current state for the TPU Node.", "readOnly": true }, "queuedResource": { "description": "Output only. The qualified name of the QueuedResource that requested this Node.", "readOnly": true, "type": "string" }, "shieldedInstanceConfig": { "$ref": "ShieldedInstanceConfig", "description": "Shielded Instance options." }, "networkEndpoints": { "items": { "$ref": "NetworkEndpoint" }, "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.", "readOnly": true, "type": "array" }, "runtimeVersion": { "type": "string", "description": "Required. The runtime version running in the Node." }, "metadata": { "type": "object", "description": "Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script", "additionalProperties": { "type": "string" } }, "health": { "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." ], "enum": [ "HEALTH_UNSPECIFIED", "HEALTHY", "TIMEOUT", "UNHEALTHY_TENSORFLOW", "UNHEALTHY_MAINTENANCE" ], "description": "The health status of the TPU node.", "type": "string" }, "schedulingConfig": { "$ref": "SchedulingConfig", "description": "The scheduling options for this node." }, "cidrBlock": { "type": "string", "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." }, "upcomingMaintenance": { "$ref": "UpcomingMaintenance", "description": "Output only. Upcoming maintenance on this TPU node.", "readOnly": true }, "name": { "type": "string", "description": "Output only. Immutable. The name of the TPU.", "readOnly": true }, "dataDisks": { "items": { "$ref": "AttachedDisk" }, "type": "array", "description": "The additional data disks for the Node." }, "healthDescription": { "description": "Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.", "readOnly": true, "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" }, "bootDiskConfig": { "$ref": "BootDiskConfig", "description": "Optional. Boot disk configuration." }, "symptoms": { "type": "array", "description": "Output only. The Symptoms that have occurred to the TPU Node.", "readOnly": true, "items": { "$ref": "Symptom" } }, "apiVersion": { "enumDescriptions": [ "API version is unknown.", "TPU API V1Alpha1 version.", "TPU API V1 version.", "TPU API V2Alpha1 version.", "TPU API V2 version." ], "enum": [ "API_VERSION_UNSPECIFIED", "V1_ALPHA1", "V1", "V2_ALPHA1", "V2" ], "description": "Output only. The API version that created this Node.", "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." }, "createTime": { "type": "string", "description": "Output only. The time when the node was created.", "readOnly": true, "format": "google-datetime" }, "acceleratorType": { "description": "Optional. The type of hardware accelerators associated with this node.", "type": "string" }, "id": { "description": "Output only. The unique identifier for the TPU Node.", "readOnly": true, "format": "int64", "type": "string" }, "description": { "type": "string", "description": "The user-supplied description of the TPU. Maximum of 512 characters." }, "networkConfigs": { "type": "array", "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" } }, "labels": { "type": "object", "description": "Resource labels to represent user-provided metadata.", "additionalProperties": { "type": "string" } }, "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" } }, "acceleratorConfig": { "description": "The AccleratorConfig for the TPU Node.", "$ref": "AcceleratorConfig" }, "multisliceNode": { "type": "boolean", "description": "Output only. Whether the Node belongs to a Multislice group.", "readOnly": true } } }, "CustomerEncryptionKey": { "type": "object", "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" } }, "description": "Defines the customer encryption key for disk encryption.", "id": "CustomerEncryptionKey" }, "StartNodeRequest": { "description": "Request for StartNode.", "type": "object", "properties": {}, "id": "StartNodeRequest" }, "DeletingData": { "id": "DeletingData", "type": "object", "properties": {}, "description": "Further data for the deleting state." }, "CreatingData": { "description": "Further data for the creating state.", "type": "object", "properties": {}, "id": "CreatingData" }, "OperationMetadata": { "type": "object", "properties": { "endTime": { "description": "The time the operation finished running.", "format": "google-datetime", "type": "string" }, "verb": { "description": "Name of the verb executed by the operation.", "type": "string" }, "target": { "type": "string", "description": "Target of the operation - for example projects/project-1/connectivityTests/test-1" }, "createTime": { "description": "The time the operation was created.", "format": "google-datetime", "type": "string" }, "cancelRequested": { "type": "boolean", "description": "Specifies if cancellation was requested for the operation." }, "apiVersion": { "type": "string", "description": "API version." }, "statusDetail": { "type": "string", "description": "Human-readable status of the operation, if any." } }, "description": "Metadata describing an Operation", "id": "OperationMetadata" }, "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", "properties": { "code": { "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32" }, "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "details": { "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array" } }, "id": "Status" }, "Tpu": { "type": "object", "properties": { "nodeSpec": { "items": { "$ref": "NodeSpec" }, "description": "Optional. The TPU node(s) being requested.", "type": "array" } }, "description": "Details of the TPU resource(s) being requested.", "id": "Tpu" }, "GuestAttributesEntry": { "description": "A guest attributes namespace/key/value entry.", "type": "object", "properties": { "namespace": { "description": "Namespace for the guest attribute entry.", "type": "string" }, "value": { "description": "Value for the guest attribute entry.", "type": "string" }, "key": { "description": "Key for the guest attribute entry.", "type": "string" } }, "id": "GuestAttributesEntry" }, "GenerateServiceIdentityResponse": { "id": "GenerateServiceIdentityResponse", "description": "Response for GenerateServiceIdentity.", "type": "object", "properties": { "identity": { "$ref": "ServiceIdentity", "description": "ServiceIdentity that was created or retrieved." } } }, "StopNodeRequest": { "id": "StopNodeRequest", "description": "Request for StopNode.", "type": "object", "properties": {} }, "MultisliceParams": { "description": "Parameters to specify for multislice QueuedResource requests. This message must be populated in case of multislice requests instead of node_id.", "type": "object", "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.", "format": "int32", "type": "integer" }, "nodeIdPrefix": { "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.", "type": "string" } }, "id": "MultisliceParams" }, "SuspendingData": { "id": "SuspendingData", "description": "Further data for the suspending state.", "type": "object", "properties": {} }, "AcceptedData": { "description": "Further data for the accepted state.", "type": "object", "properties": {}, "id": "AcceptedData" }, "ServiceAccount": { "type": "object", "properties": { "email": { "description": "Email address of the service account. If empty, default Compute service account will be used.", "type": "string" }, "scope": { "items": { "type": "string" }, "type": "array", "description": "The list of scopes to be made available for this service account. If empty, access to all Cloud APIs will be allowed." } }, "description": "A service account.", "id": "ServiceAccount" }, "ResetQueuedResourceRequest": { "description": "Request for ResetQueuedResource.", "type": "object", "properties": {}, "id": "ResetQueuedResourceRequest" }, "UpcomingMaintenance": { "id": "UpcomingMaintenance", "description": "Upcoming Maintenance notification information.", "type": "object", "properties": { "canReschedule": { "type": "boolean", "description": "Indicates if the maintenance can be customer triggered." }, "windowStartTime": { "type": "string", "description": "The current start time of the maintenance window. This timestamp value is in RFC3339 text format." }, "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)." ], "enum": [ "UNKNOWN_TYPE", "SCHEDULED", "UNSCHEDULED" ], "type": "string", "description": "Defines the type of maintenance." }, "windowEndTime": { "description": "The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.", "type": "string" }, "latestWindowStartTime": { "description": "The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.", "type": "string" }, "maintenanceStatus": { "type": "string", "description": "The status of the maintenance.", "enumDescriptions": [ "Unknown maintenance status. Do not use this value.", "There is pending maintenance.", "There is ongoing maintenance on this VM." ], "enum": [ "UNKNOWN", "PENDING", "ONGOING" ] } } }, "FailedData": { "description": "Further data for the failed state.", "type": "object", "properties": { "error": { "description": "Output only. The error that caused the queued resource to enter the FAILED state.", "readOnly": true, "$ref": "Status" } }, "id": "FailedData" }, "ActiveData": { "id": "ActiveData", "type": "object", "properties": {}, "description": "Further data for the active state." }, "GenerateServiceIdentityRequest": { "type": "object", "properties": {}, "description": "Request for GenerateServiceIdentity.", "id": "GenerateServiceIdentityRequest" }, "GetGuestAttributesResponse": { "type": "object", "properties": { "guestAttributes": { "items": { "$ref": "GuestAttributes" }, "type": "array", "description": "The guest attributes for the TPU workers." } }, "description": "Response for GetGuestAttributes.", "id": "GetGuestAttributesResponse" } }, "name": "tpu", "basePath": "", "protocol": "rest", "baseUrl": "https://tpu.googleapis.com/", "servicePath": "", "ownerName": "Google", "revision": "20260127", "title": "Cloud TPU API", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "description": "TPU API provides customers with access to Google TPU technology.", "kind": "discovery#restDescription", "id": "tpu:v2", "resources": { "projects": { "resources": { "locations": { "resources": { "queuedResources": { "methods": { "create": { "id": "tpu.projects.locations.queuedResources.create", "response": { "$ref": "Operation" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a QueuedResource TPU instance.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queuedResources", "parameters": { "queuedResourceId": { "location": "query", "type": "string", "description": "Optional. The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource name.", "required": true, "type": "string" }, "requestId": { "location": "query", "description": "Optional. Idempotent request UUID.", "type": "string" } }, "httpMethod": "POST", "request": { "$ref": "QueuedResource" }, "path": "v2/{+parent}/queuedResources" }, "delete": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a QueuedResource TPU instance.", "id": "tpu.projects.locations.queuedResources.delete", "response": { "$ref": "Operation" }, "path": "v2/{+name}", "httpMethod": "DELETE", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queuedResources/{queuedResourcesId}", "parameters": { "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" }, "requestId": { "type": "string", "description": "Optional. Idempotent request UUID.", "location": "query" }, "name": { "description": "Required. The resource name.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/queuedResources/[^/]+$", "location": "path" } } }, "list": { "description": "Lists queued resources.", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "tpu.projects.locations.queuedResources.list", "response": { "$ref": "ListQueuedResourcesResponse" }, "path": "v2/{+parent}/queuedResources", "httpMethod": "GET", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queuedResources", "parameters": { "pageSize": { "location": "query", "type": "integer", "description": "Optional. The maximum number of items to return.", "format": "int32" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The next_page_token value returned from a previous List request, if any." }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "description": "Required. The parent resource name." } } }, "get": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queuedResources/{queuedResourcesId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/queuedResources/[^/]+$", "location": "path", "description": "Required. The resource name.", "required": true, "type": "string" } }, "path": "v2/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a queued resource.", "id": "tpu.projects.locations.queuedResources.get", "response": { "$ref": "QueuedResource" } }, "reset": { "httpMethod": "POST", "request": { "$ref": "ResetQueuedResourceRequest" }, "path": "v2/{+name}:reset", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queuedResources/{queuedResourcesId}:reset", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/queuedResources/[^/]+$", "required": true, "type": "string", "description": "Required. The name of the queued resource." } }, "id": "tpu.projects.locations.queuedResources.reset", "response": { "$ref": "Operation" }, "description": "Resets a QueuedResource TPU instance", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "operations": { "methods": { "list": { "id": "tpu.projects.locations.operations.list", "response": { "$ref": "ListOperationsResponse" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET", "path": "v2/{+name}/operations", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "The name of the operation's parent resource.", "required": true, "type": "string" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "pageSize": { "description": "The standard list page size.", "format": "int32", "type": "integer", "location": "query" }, "returnPartialSuccess": { "location": "query", "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" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" } } }, "get": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "tpu.projects.locations.operations.get", "response": { "$ref": "Operation" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation resource." } }, "path": "v2/{+name}", "httpMethod": "GET" }, "delete": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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`.", "id": "tpu.projects.locations.operations.delete", "response": { "$ref": "Empty" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path" } }, "path": "v2/{+name}", "httpMethod": "DELETE" }, "cancel": { "httpMethod": "POST", "path": "v2/{+name}:cancel", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation resource to be cancelled." } }, "id": "tpu.projects.locations.operations.cancel", "response": { "$ref": "Empty" }, "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`.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "acceleratorTypes": { "methods": { "list": { "id": "tpu.projects.locations.acceleratorTypes.list", "response": { "$ref": "ListAcceleratorTypesResponse" }, "description": "Lists accelerator types supported by this API.", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "path": "v2/{+parent}/acceleratorTypes", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/acceleratorTypes", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent resource name.", "required": true, "type": "string" }, "pageToken": { "description": "The next_page_token value returned from a previous List request, if any.", "type": "string", "location": "query" }, "orderBy": { "type": "string", "description": "Sort results.", "location": "query" }, "pageSize": { "description": "The maximum number of items to return.", "format": "int32", "type": "integer", "location": "query" }, "filter": { "description": "List filter.", "type": "string", "location": "query" } } }, "get": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/acceleratorTypes/{acceleratorTypesId}", "parameters": { "name": { "description": "Required. The resource name.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/acceleratorTypes/[^/]+$", "location": "path" } }, "path": "v2/{+name}", "httpMethod": "GET", "description": "Gets AcceleratorType.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "tpu.projects.locations.acceleratorTypes.get", "response": { "$ref": "AcceleratorType" } } } }, "runtimeVersions": { "methods": { "list": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/runtimeVersions", "parameters": { "parent": { "description": "Required. The parent resource name.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "pageToken": { "location": "query", "type": "string", "description": "The next_page_token value returned from a previous List request, if any." }, "orderBy": { "location": "query", "type": "string", "description": "Sort results." }, "pageSize": { "type": "integer", "description": "The maximum number of items to return.", "format": "int32", "location": "query" }, "filter": { "type": "string", "description": "List filter.", "location": "query" } }, "path": "v2/{+parent}/runtimeVersions", "httpMethod": "GET", "description": "Lists runtime versions supported by this API.", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "tpu.projects.locations.runtimeVersions.list", "response": { "$ref": "ListRuntimeVersionsResponse" } }, "get": { "httpMethod": "GET", "path": "v2/{+name}", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/runtimeVersions/{runtimeVersionsId}", "parameters": { "name": { "description": "Required. The resource name.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/runtimeVersions/[^/]+$", "location": "path" } }, "id": "tpu.projects.locations.runtimeVersions.get", "response": { "$ref": "RuntimeVersion" }, "description": "Gets a runtime version.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "nodes": { "methods": { "list": { "httpMethod": "GET", "path": "v2/{+parent}/nodes", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nodes", "parameters": { "pageSize": { "description": "The maximum number of items to return.", "format": "int32", "type": "integer", "location": "query" }, "pageToken": { "location": "query", "description": "The next_page_token value returned from a previous List request, if any.", "type": "string" }, "parent": { "required": true, "type": "string", "description": "Required. The parent resource name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "id": "tpu.projects.locations.nodes.list", "response": { "$ref": "ListNodesResponse" }, "description": "Lists nodes.", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}", "parameters": { "name": { "description": "Required. The resource name.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", "location": "path" } }, "path": "v2/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the details of a node.", "id": "tpu.projects.locations.nodes.get", "response": { "$ref": "Node" } }, "start": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:start", "parameters": { "name": { "description": "Required. The resource name.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", "location": "path" } }, "path": "v2/{+name}:start", "httpMethod": "POST", "request": { "$ref": "StartNodeRequest" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Starts a node.", "id": "tpu.projects.locations.nodes.start", "response": { "$ref": "Operation" } }, "patch": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the configurations of a node.", "id": "tpu.projects.locations.nodes.patch", "response": { "$ref": "Operation" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", "required": true, "type": "string", "description": "Output only. Immutable. The name of the TPU." }, "updateMask": { "location": "query", "description": "Required. Mask of fields from Node to update. Supported fields: [description, tags, labels, metadata, network_config.enable_external_ips].", "format": "google-fieldmask", "type": "string" } }, "path": "v2/{+name}", "httpMethod": "PATCH", "request": { "$ref": "Node" } }, "create": { "description": "Creates a node.", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "tpu.projects.locations.nodes.create", "response": { "$ref": "Operation" }, "path": "v2/{+parent}/nodes", "httpMethod": "POST", "request": { "$ref": "Node" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nodes", "parameters": { "nodeId": { "description": "The unqualified resource name.", "type": "string", "location": "query" }, "parent": { "description": "Required. The parent resource name.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" } } }, "delete": { "path": "v2/{+name}", "httpMethod": "DELETE", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}", "parameters": { "name": { "description": "Required. The resource name.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", "location": "path" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a node.", "id": "tpu.projects.locations.nodes.delete", "response": { "$ref": "Operation" } }, "stop": { "description": "Stops a node. This operation is only available with single TPU nodes.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "tpu.projects.locations.nodes.stop", "response": { "$ref": "Operation" }, "path": "v2/{+name}:stop", "httpMethod": "POST", "request": { "$ref": "StopNodeRequest" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:stop", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", "location": "path", "description": "Required. The resource name.", "required": true, "type": "string" } } }, "getGuestAttributes": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:getGuestAttributes", "parameters": { "name": { "description": "Required. The resource name.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", "location": "path" } }, "httpMethod": "POST", "request": { "$ref": "GetGuestAttributesRequest" }, "path": "v2/{+name}:getGuestAttributes", "id": "tpu.projects.locations.nodes.getGuestAttributes", "response": { "$ref": "GetGuestAttributesResponse" }, "description": "Retrieves the guest attributes for the node.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } }, "methods": { "generateServiceIdentity": { "path": "v2/{+parent}:generateServiceIdentity", "httpMethod": "POST", "request": { "$ref": "GenerateServiceIdentityRequest" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}:generateServiceIdentity", "parameters": { "parent": { "description": "Required. The parent resource name.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" } }, "description": "Generates the Cloud TPU service identity for the project.", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "tpu.projects.locations.generateServiceIdentity", "response": { "$ref": "GenerateServiceIdentityResponse" } }, "list": { "path": "v2/{+name}/locations", "httpMethod": "GET", "flatPath": "v2/projects/{projectsId}/locations", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page." }, "filter": { "location": "query", "type": "string", "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)." }, "pageSize": { "location": "query", "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "type": "integer" }, "name": { "location": "path", "pattern": "^projects/[^/]+$", "required": true, "type": "string", "description": "The resource that owns the locations collection, if applicable." }, "extraLocationTypes": { "type": "string", "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 } }, "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" ], "id": "tpu.projects.locations.list", "response": { "$ref": "ListLocationsResponse" } }, "get": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}", "parameters": { "name": { "description": "Resource name for the location.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" } }, "httpMethod": "GET", "path": "v2/{+name}", "id": "tpu.projects.locations.get", "response": { "$ref": "Location" }, "description": "Gets information about a location.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } }, "batchPath": "batch", "parameters": { "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "quotaUser": { "location": "query", "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." }, "$.xgafv": { "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "description": "V1 error format.", "type": "string" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "prettyPrint": { "type": "boolean", "default": "true", "description": "Returns response with indentations and line breaks.", "location": "query" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "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", "default": "json", "description": "Data format for response." } }, "fullyEncodeReservedExpansion": true, "documentationLink": "https://cloud.google.com/tpu/", "discoveryVersion": "v1", "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." } } } }, "rootUrl": "https://tpu.googleapis.com/", "mtlsRootUrl": "https://tpu.mtls.googleapis.com/", "ownerDomain": "google.com" }