Method: projects.locations.notebookRuntimes.assign

Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.

HTTP request

POST https://{service-endpoint}/v1beta1/{parent}/notebookRuntimes:assign

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
parent

string

Required. The resource name of the Location to get the NotebookRuntime assignment. Format: projects/{project}/locations/{location}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "notebookRuntimeTemplate": string,
  "notebookRuntime": {
    object (NotebookRuntime)
  },
  "notebookRuntimeId": string
}
Fields
notebookRuntimeTemplate

string

Required. The resource name of the NotebookRuntimeTemplate based on which a NotebookRuntime will be assigned (reuse or create a new one).
notebookRuntime

object (NotebookRuntime)

Required. Provide runtime specific information (e.g. runtime owner, notebook id) used for NotebookRuntime assignment.
notebookRuntimeId

string

Optional. user specified ID for the notebook runtime.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.notebookRuntimes.assign

For more information, see the IAM documentation.