Method: projects.locations.notebookExecutionJobs.list

Lists NotebookExecutionJobs in a Location.

HTTP request

GET https://{service-endpoint}/v1beta1/{parent}/notebookExecutionJobs

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

  • notebookExecutionJob supports = and !=. notebookExecutionJob represents the NotebookExecutionJob ID.
  • displayName supports = and != and regex.
  • schedule supports = and != and regex.

Some examples: * notebookExecutionJob="123" * notebookExecutionJob="my-execution-job" * displayName="myDisplayName" and displayName=~"myDisplayNameRegex"
pageSize

integer

Optional. The standard list page size.
pageToken

string

Optional. The standard list page token. Typically obtained via [notebookExecutionJobs.list.next_page_token][] of the previous NotebookService.ListNotebookExecutionJobs call.
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.
view

enum (NotebookExecutionJobView)

Optional. The NotebookExecutionJob view. Defaults to BASIC.

Request body

The request body must be empty.

Response body

Response message for [NotebookService.CreateNotebookExecutionJob]

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

JSON representation 
{
  "notebookExecutionJobs": [
    {
      object (NotebookExecutionJob)
    }
  ],
  "nextPageToken": string
}
Fields
notebookExecutionJobs[]

object (NotebookExecutionJob)

List of NotebookExecutionJobs in the requested page.
nextPageToken

string

A token to retrieve next page of results. Pass to [notebookExecutionJobs.list.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.notebookExecutionJobs.list

For more information, see the IAM documentation.