Vertex AI API (aiplatform:v1)

2024-03-12

2 new methods

Additions

    Methods
  • aiplatform.projects.locations.tuningJobs.operations.cancel

      Parameters :

        name

          Type : string

          Location : path

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

          Description : The name of the operation resource to be cancelled.

          Required : Yes

      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 : v1/{+name}:cancel

      HTTP Method : POST

      Parameter Order : name

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel

  • aiplatform.projects.locations.tuningJobs.operations.get

      Path : v1/{+name}

      HTTP Method : GET

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}

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

      Parameters :

        name

          Type : string

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

          Location : path

          Required : Yes

          Description : The name of the operation resource.

      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.

      Parameter Order : name