Cloud TPU API (tpu:v2)

2024-02-09

5 new methods

Additions

    Methods
  • tpu.projects.locations.queuedResources.list

      Path: v2/{+parent}/queuedResources

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/queuedResources

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The parent resource name.

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Location: path

          Required: Yes

          Type: string

        pageSize

          Description: Optional. The maximum number of items to return.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Description: Optional. The next_page_token value returned from a previous List request, if any.

          Location: query

          Type: string

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Lists queued resources.

  • tpu.projects.locations.queuedResources.get

      Path: v2/{+name}

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/queuedResources/{queuedResourcesId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The resource name.

          Pattern: ^projects/[^/]+/locations/[^/]+/queuedResources/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Gets details of a queued resource.

  • tpu.projects.locations.queuedResources.create

      Path: v2/{+parent}/queuedResources

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/queuedResources

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. The parent resource name.

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Location: path

          Required: Yes

          Type: string

        queuedResourceId

          Description: Optional. The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format.

          Location: query

          Type: string

        requestId

          Description: Optional. Idempotent request UUID.

          Location: query

          Type: string

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Creates a QueuedResource TPU instance.

  • tpu.projects.locations.queuedResources.delete

      Path: v2/{+name}

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/queuedResources/{queuedResourcesId}

      HTTP Method: DELETE

      Parameters:

        name

          Description: Required. The resource name.

          Pattern: ^projects/[^/]+/locations/[^/]+/queuedResources/[^/]+$

          Location: path

          Required: Yes

          Type: string

        requestId

          Description: Optional. Idempotent request UUID.

          Location: query

          Type: string

        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.

          Location: query

          Type: boolean

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Deletes a QueuedResource TPU instance.

  • tpu.projects.locations.queuedResources.reset

      Path: v2/{+name}:reset

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/queuedResources/{queuedResourcesId}:reset

      HTTP Method: POST

      Parameters:

        name

          Description: Required. The name of the queued resource.

          Pattern: ^projects/[^/]+/locations/[^/]+/queuedResources/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Resets a QueuedResource TPU instance