Vertex AI API (aiplatform:v1)

2024-03-23

6 new methods

Additions

    Methods
  • aiplatform.projects.locations.persistentResources.operations.get

      Parameter Order : name

      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.

      Parameters :

        name

          Description : The name of the operation resource.

          Type : string

          Required : Yes

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

          Location : path

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}

      Path : v1/{+name}

      HTTP Method : GET

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

  • aiplatform.projects.locations.persistentResources.operations.wait

      Parameters :

        name

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

          Location : path

          Type : string

          Description : The name of the operation resource to wait on.

          Required : Yes

        timeout

          Format : google-duration

          Description : The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

          Location : query

          Type : string

      Path : v1/{+name}:wait

      Parameter Order : name

      Description : Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

      HTTP Method : POST

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait

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

  • aiplatform.projects.locations.persistentResources.operations.list

      Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

      HTTP Method : GET

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations

      Parameters :

        filter

          Location : query

          Description : The standard list filter.

          Type : string

        pageSize

          Location : query

          Description : The standard list page size.

          Format : int32

          Type : integer

        pageToken

          Location : query

          Type : string

          Description : The standard list page token.

        name

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

          Description : The name of the operation's parent resource.

          Location : path

          Required : Yes

          Type : string

      Path : v1/{+name}/operations

      Parameter Order : name

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

  • aiplatform.projects.locations.persistentResources.operations.delete

      Path : v1/{+name}

      HTTP Method : DELETE

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

      Parameter Order : name

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}

      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

          Type : string

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

          Location : path

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

          Required : Yes

  • aiplatform.projects.locations.persistentResources.operations.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`.

      Path : v1/{+name}:cancel

      Parameter Order : name

      HTTP Method : POST

      Parameters :

        name

          Required : Yes

          Location : path

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

          Type : string

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

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel

  • aiplatform.projects.locations.persistentResources.reboot

      Parameter Order : name

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot

      Path : v1/{+name}:reboot

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

      Parameters :

        name

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

          Description : Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`

          Location : path

          Required : Yes

          Type : string

      HTTP Method : POST

      Description : Reboots a PersistentResource.