list method

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

Lists PipelineJobs in a Location.

Request parameters:

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

filter - Lists the PipelineJobs that match the filter expression. The following fields are supported: * pipeline_name: Supports = and != comparisons. * display_name: Supports =, != comparisons, and : wildcard. * pipeline_job_user_id: Supports =, != comparisons, and : wildcard. for example, can check if pipeline's display_name contains step by doing display_name:"step" * state: Supports = and != comparisons. * create_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format. * update_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format. * end_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format. * labels: Supports key-value equality and key presence. * template_uri: Supports =, != comparisons, and : wildcard. * template_metadata.version: Supports =, != comparisons, and : wildcard. Filter expressions can be combined together using logical operators (AND & OR). For example: pipeline_name="test" AND create_time>"2020-05-18T13:30:00Z". The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * create_time>"2021-05-18T00:00:00Z" OR update_time>"2020-05-18T00:00:00Z" PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. * labels.env = "prod" PipelineJobs with label "env" set to "prod".

orderBy - A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided e.g. "create_time desc, end_time", "end_time, start_time, update_time" For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * create_time * update_time * end_time * start_time

pageSize - The standard list page size.

pageToken - The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.

readMask - Mask specifying which fields to read.

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

Completes with a GoogleCloudAiplatformV1ListPipelineJobsResponse.

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<GoogleCloudAiplatformV1ListPipelineJobsResponse> list(
  core.String parent, {
  core.String? filter,
  core.String? orderBy,
  core.int? pageSize,
  core.String? pageToken,
  core.String? readMask,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': [filter],
    if (orderBy != null) 'orderBy': [orderBy],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if (readMask != null) 'readMask': [readMask],
    if ($fields != null) 'fields': [$fields],
  };

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

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