list method

Future<GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse> list(String parent, { String? filter, String? orderBy, int? pageSize, String? pageToken, String? view, String? $fields, })

Lists NotebookExecutionJobs in a Location.

Request parameters:

parent - Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: projects/{project}/locations/{location} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - 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"

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

pageSize - Optional. The standard list page size.

pageToken - Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.

view - Optional. The NotebookExecutionJob view. Defaults to BASIC. Possible string values are:

• "NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED" : When unspecified, the API defaults to the BASIC view.
• "NOTEBOOK_EXECUTION_JOB_VIEW_BASIC" : Includes all fields except for direct notebook inputs.
• "NOTEBOOK_EXECUTION_JOB_VIEW_FULL" : Includes all fields.

$fields - Selector specifying which fields to include in a partial response.

Completes with a GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse> list(
  core.String parent, {
  core.String? filter,
  core.String? orderBy,
  core.int? pageSize,
  core.String? pageToken,
  core.String? view,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'filter': ?filter == null ? null : [filter],
    'orderBy': ?orderBy == null ? null : [orderBy],
    'pageSize': ?pageSize == null ? null : ['${pageSize}'],
    'pageToken': ?pageToken == null ? null : [pageToken],
    'view': ?view == null ? null : [view],
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ =
      'v1/' + core.Uri.encodeFull('$parent') + '/notebookExecutionJobs';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse.fromJson(
    response_ as core.Map<core.String, core.dynamic>,
  );
}