Method: projects.locations.notebookRuntimeTemplates.list

Lists NotebookRuntimeTemplates in a Location.

HTTP request

GET https://{service-endpoint}/v1/{parent}/notebookRuntimeTemplates

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

Path parameters

Parameters
parent

string

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

Query parameters

Parameters
filter

string

Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

  • notebookRuntimeTemplate supports = and !=. notebookRuntimeTemplate represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name.
  • displayName supports = and !=
  • labels supports general map functions that is:
    • labels.key=value - key:value equality
    • `labels.key:* or labels:key - key existence
    • A key including a space must be quoted. labels."a key".
  • notebookRuntimeType supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK].

Some examples:

  • notebookRuntimeTemplate=notebookRuntimeTemplate123
  • displayName="myDisplayName"
  • labels.myKey="myValue"
  • notebookRuntimeType=USER_DEFINED
pageSize

integer

Optional. The standard list page size.
pageToken

string

Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call.
readMask

string (FieldMask format)

Optional. Mask specifying which fields to read.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
orderBy

string

Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:

  • displayName
  • createTime
  • updateTime

Example: displayName, createTime desc.

Request body

The request body must be empty.

Response body

Response message for NotebookService.ListNotebookRuntimeTemplates.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "notebookRuntimeTemplates": [
    {
      object (NotebookRuntimeTemplate)
    }
  ],
  "nextPageToken": string
}
Fields
notebookRuntimeTemplates[]

object (NotebookRuntimeTemplate)

List of NotebookRuntimeTemplates in the requested page.
nextPageToken

string

A token to retrieve next page of results. Pass to ListNotebookRuntimeTemplatesRequest.page_token to obtain that page.

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.notebookRuntimeTemplates.list

For more information, see the IAM documentation.