2022-10-27
▼ ▲ tpu.projects.locations.generateServiceIdentity
HTTP Method: POST
Description: Generates the Cloud TPU service identity for the project.
Flat Path: v2/projects/{projectsId}/locations/{locationsId}:generateServiceIdentity
Parameter Order: parent
Parameters:
parent
Required: Yes
Description: Required. The parent resource name.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
Path: v2/{+parent}:generateServiceIdentity
▼ ▲ tpu.projects.locations.get
HTTP Method: GET
Flat Path: v2/projects/{projectsId}/locations/{locationsId}
Description: Gets information about a location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v2/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Description: Resource name for the location.
Required: Yes
Type: string
Parameter Order: name
▼ ▲ tpu.projects.locations.list
Path: v2/{+name}/locations
Parameters:
name
Location: path
Required: Yes
Description: The resource that owns the locations collection, if applicable.
Pattern: ^projects/[^/]+$
Type: string
pageSize
Type: integer
Location: query
Description: The maximum number of results to return. If not set, the service selects a default.
Format: int32
filter
Type: string
Location: query
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).
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
HTTP Method: GET
Flat Path: v2/projects/{projectsId}/locations
Description: Lists information about the supported locations for this service.
Parameter Order: name
▼ ▲ tpu.projects.locations.nodes.delete
Parameters:
name
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/nodes/[^/]+$
Description: Required. The resource name.
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a node.
Path: v2/{+name}
Parameter Order: name
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}
▼ ▲ tpu.projects.locations.nodes.getGuestAttributes
Description: Retrieves the guest attributes for the node.
Parameter Order: name
Path: v2/{+name}:getGuestAttributes
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/nodes/[^/]+$
Description: Required. The resource name.
Type: string
Required: Yes
Location: path
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:getGuestAttributes
HTTP Method: POST
▼ ▲ tpu.projects.locations.nodes.stop
Description: Stops a node. This operation is only available with single TPU nodes.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/nodes/[^/]+$
Type: string
Location: path
Description: The resource name.
Required: Yes
Path: v2/{+name}:stop
HTTP Method: POST
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:stop
▼ ▲ tpu.projects.locations.nodes.patch
Path: v2/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/nodes/[^/]+$
Type: string
Description: Output only. Immutable. The name of the TPU.
Location: path
Required: Yes
updateMask
Format: google-fieldmask
Type: string
Location: query
Description: Required. Mask of fields from Node to update. Supported fields: [description, tags, labels, metadata, network_config.enable_external_ips].
Description: Updates the configurations of a node.
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}
Parameter Order: name
HTTP Method: PATCH
▼ ▲ tpu.projects.locations.nodes.list
Description: Lists nodes.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Path: v2/{+parent}/nodes
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/nodes
Parameters:
pageToken
Description: The next_page_token value returned from a previous List request, if any.
Type: string
Location: query
parent
Location: path
Required: Yes
Type: string
Description: Required. The parent resource name.
Pattern: ^projects/[^/]+/locations/[^/]+$
pageSize
Location: query
Description: The maximum number of items to return.
Type: integer
Format: int32
▼ ▲ tpu.projects.locations.nodes.start
Parameters:
name
Location: path
Required: Yes
Type: string
Description: The resource name.
Pattern: ^projects/[^/]+/locations/[^/]+/nodes/[^/]+$
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Starts a node.
HTTP Method: POST
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:start
Path: v2/{+name}:start
▼ ▲ tpu.projects.locations.nodes.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v2/{+parent}/nodes
Description: Creates a node.
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/nodes
Parameters:
nodeId
Description: The unqualified resource name.
Location: query
Type: string
parent
Required: Yes
Description: Required. The parent resource name.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
HTTP Method: POST
Parameter Order: parent
▼ ▲ tpu.projects.locations.nodes.get
Description: Gets the details of a node.
Parameter Order: name
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/nodes/[^/]+$
Required: Yes
Description: Required. The resource name.
Location: path
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}
Path: v2/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ tpu.projects.locations.operations.delete
Path: v2/{+name}
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: 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`.
Parameters:
name
Location: path
Required: Yes
Type: string
Description: The name of the operation resource to be deleted.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
▼ ▲ tpu.projects.locations.operations.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.
HTTP Method: GET
Parameters:
name
Type: string
Required: Yes
Location: path
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Path: v2/{+name}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
▼ ▲ tpu.projects.locations.operations.cancel
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
HTTP Method: POST
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`.
Path: v2/{+name}:cancel
Parameters:
name
Description: The name of the operation resource to be cancelled.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type: string
Location: path
Required: Yes
Parameter Order: name
▼ ▲ tpu.projects.locations.operations.list
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/operations
Parameters:
pageSize
Format: int32
Description: The standard list page size.
Location: query
Type: integer
filter
Description: The standard list filter.
Type: string
Location: query
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
Description: The name of the operation's parent resource.
pageToken
Type: string
Description: The standard list page token.
Location: query
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v2/{+name}/operations
▼ ▲ tpu.projects.locations.runtimeVersions.list
Description: Lists runtime versions supported by this API.
Path: v2/{+parent}/runtimeVersions
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: parent
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/runtimeVersions
Parameters:
filter
Description: List filter.
Location: query
Type: string
pageSize
Format: int32
Location: query
Description: The maximum number of items to return.
Type: integer
pageToken
Location: query
Description: The next_page_token value returned from a previous List request, if any.
Type: string
orderBy
Description: Sort results.
Location: query
Type: string
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. The parent resource name.
Location: path
Required: Yes
▼ ▲ tpu.projects.locations.runtimeVersions.get
Path: v2/{+name}
HTTP Method: GET
Parameter Order: name
Parameters:
name
Location: path
Type: string
Description: Required. The resource name.
Pattern: ^projects/[^/]+/locations/[^/]+/runtimeVersions/[^/]+$
Required: Yes
Description: Gets a runtime version.
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/runtimeVersions/{runtimeVersionsId}
▼ ▲ tpu.projects.locations.acceleratorTypes.get
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v2/{+name}
Parameters:
name
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/acceleratorTypes/[^/]+$
Description: Required. The resource name.
Location: path
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/acceleratorTypes/{acceleratorTypesId}
Description: Gets AcceleratorType.
▼ ▲ tpu.projects.locations.acceleratorTypes.list
Description: Lists accelerator types supported by this API.
Path: v2/{+parent}/acceleratorTypes
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/acceleratorTypes
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameters:
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Description: Required. The parent resource name.
Type: string
pageToken
Type: string
Location: query
Description: The next_page_token value returned from a previous List request, if any.
orderBy
Description: Sort results.
Type: string
Location: query
pageSize
Type: integer
Format: int32
Location: query
Description: The maximum number of items to return.
filter
Location: query
Type: string
Description: List filter.
Parameter Order: parent