Vertex AI API (aiplatform:v1beta1)

2024-06-18

15 new methods

Additions

    Methods
  • aiplatform.projects.locations.notebookRuntimeTemplates.operations.list

      HTTP Method: GET

      Parameter Order: name

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

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations

      Parameters:

        pageSize

          Description: The standard list page size.

          Location: query

          Format: int32

          Type: integer

        pageToken

          Description: The standard list page token.

          Location: query

          Type: string

        filter

          Location: query

          Type: string

          Description: The standard list filter.

        name

          Required: Yes

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

          Location: path

          Type: string

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

      Path: v1beta1/{+name}/operations

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

  • aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel

      Path: v1beta1/{+name}:cancel

      HTTP Method: POST

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel

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

      Parameters:

        name

          Type: string

          Location: path

          Required: Yes

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

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

      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`.

      Parameter Order: name

  • aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait

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

      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.

      Path: v1beta1/{+name}:wait

      Parameter Order: name

      Parameters:

        timeout

          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

          Format: google-duration

          Type: string

        name

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

          Required: Yes

          Type: string

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

          Location: path

      HTTP Method: POST

  • aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete

      Parameters:

        name

          Location: path

          Type: string

          Required: Yes

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

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

      Parameter Order: name

      Path: v1beta1/{+name}

      HTTP Method: DELETE

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

      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`.

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}

  • aiplatform.projects.locations.notebookRuntimeTemplates.operations.get

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}

      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.

      Path: v1beta1/{+name}

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

      Parameters:

        name

          Location: path

          Description: The name of the operation resource.

          Type: string

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

          Required: Yes

      Parameter Order: name

      HTTP Method: GET

  • aiplatform.projects.locations.notebookRuntimes.operations.wait

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

      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.

      Parameter Order: name

      Parameters:

        name

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

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

          Required: Yes

          Type: string

          Location: path

        timeout

          Type: string

          Location: query

          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.

      Path: v1beta1/{+name}:wait

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait

      HTTP Method: POST

  • aiplatform.projects.locations.notebookRuntimes.operations.list

      Parameter Order: name

      HTTP Method: GET

      Parameters:

        pageSize

          Description: The standard list page size.

          Type: integer

          Location: query

          Format: int32

        pageToken

          Description: The standard list page token.

          Location: query

          Type: string

        filter

          Location: query

          Description: The standard list filter.

          Type: string

        name

          Type: string

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

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

          Required: Yes

          Location: path

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

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations

      Path: v1beta1/{+name}/operations

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

  • aiplatform.projects.locations.notebookRuntimes.operations.delete

      Parameters:

        name

          Location: path

          Type: string

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

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

          Required: Yes

      Path: v1beta1/{+name}

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

      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`.

      HTTP Method: DELETE

      Parameter Order: name

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}

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

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel

      Parameter Order: name

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

      Path: v1beta1/{+name}:cancel

      HTTP Method: POST

      Parameters:

        name

          Required: Yes

          Location: path

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

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

          Type: string

  • aiplatform.projects.locations.notebookRuntimes.operations.get

      Parameters:

        name

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

          Location: path

          Description: The name of the operation resource.

          Required: Yes

          Type: string

      Path: v1beta1/{+name}

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

      HTTP Method: 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.

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}

  • aiplatform.projects.locations.notebookExecutionJobs.operations.get

      HTTP Method: GET

      Path: v1beta1/{+name}

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

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}

      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

          Required: Yes

          Type: string

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

          Description: The name of the operation resource.

          Location: path

  • aiplatform.projects.locations.notebookExecutionJobs.operations.delete

      HTTP Method: DELETE

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

      Parameters:

        name

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

          Type: string

          Required: Yes

          Location: path

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

      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`.

      Path: v1beta1/{+name}

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}

      Parameter Order: name

  • aiplatform.projects.locations.notebookExecutionJobs.operations.wait

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait

      Parameter Order: name

      Parameters:

        timeout

          Format: google-duration

          Type: string

          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

        name

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

          Required: Yes

          Type: string

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

          Location: path

      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.

      Path: v1beta1/{+name}:wait

      HTTP Method: POST

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

  • aiplatform.projects.locations.notebookExecutionJobs.operations.cancel

      HTTP Method: POST

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel

      Parameter Order: name

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

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

      Parameters:

        name

          Type: string

          Location: path

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

          Required: Yes

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

  • aiplatform.projects.locations.notebookExecutionJobs.operations.list

      Parameter Order: name

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations

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

      HTTP Method: GET

      Path: v1beta1/{+name}/operations

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

      Parameters:

        pageToken

          Type: string

          Location: query

          Description: The standard list page token.

        pageSize

          Description: The standard list page size.

          Format: int32

          Location: query

          Type: integer

        filter

          Description: The standard list filter.

          Location: query

          Type: string

        name

          Location: path

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

          Type: string

          Required: Yes

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