Method: notebookExecutionJobs.list

Full name: projects.locations.notebookExecutionJobs.list

Lists NotebookExecutionJobs in a Location.

Endpoint

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

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

Path parameters

parent string

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

Query 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 ListNotebookExecutionJobsResponse.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:

Fields
notebookExecutionJobs[] object (NotebookExecutionJob)

List of NotebookExecutionJobs in the requested page.

nextPageToken string

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

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