Vertex AI API (aiplatform:v1)

2024-03-19

5 new methods

Additions

    Methods
  • aiplatform.projects.locations.persistentResources.patch

      Parameter Order : name

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

      Path : v1/{+name}

      Parameters :

        updateMask

          Description : Required. Specify the fields to be overwritten in the PersistentResource by the update method.

          Format : google-fieldmask

          Type : string

          Location : query

        name

          Description : Immutable. Resource name of a PersistentResource.

          Type : string

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

          Required : Yes

          Location : path

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

      HTTP Method : PATCH

      Description : Updates a PersistentResource.

  • aiplatform.projects.locations.persistentResources.delete

      Parameters :

        name

          Type : string

          Description : Required. The name of the PersistentResource to be deleted. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`

          Location : path

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

          Required : Yes

      Description : Deletes a PersistentResource.

      HTTP Method : DELETE

      Parameter Order : name

      Path : v1/{+name}

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

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

  • aiplatform.projects.locations.persistentResources.list

      Path : v1/{+parent}/persistentResources

      Parameters :

        parent

          Type : string

          Location : path

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

          Description : Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project}/locations/{location}`

          Required : Yes

        pageSize

          Type : integer

          Description : Optional. The standard list page size.

          Format : int32

          Location : query

        pageToken

          Description : Optional. The standard list page token. Typically obtained via ListPersistentResourceResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call.

          Type : string

          Location : query

      HTTP Method : GET

      Description : Lists PersistentResources in a Location.

      Parameter Order : parent

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

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

  • aiplatform.projects.locations.persistentResources.create

      HTTP Method : POST

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

      Parameter Order : parent

      Path : v1/{+parent}/persistentResources

      Description : Creates a PersistentResource.

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

      Parameters :

        parent

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

          Description : Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project}/locations/{location}`

          Required : Yes

          Location : path

          Type : string

        persistentResourceId

          Description : Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.

          Location : query

          Type : string

  • aiplatform.projects.locations.persistentResources.get

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

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

      Parameters :

        name

          Location : path

          Required : Yes

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

          Type : string

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

      Parameter Order : name

      Path : v1/{+name}

      HTTP Method : GET

      Description : Gets a PersistentResource.