list method

Future<ListJobRunsResponse> list(
  1. String parent, {
  2. String? filter,
  3. String? orderBy,
  4. int? pageSize,
  5. String? pageToken,
  6. String? $fields,
})

Lists JobRuns in a given project and location.

Request parameters:

parent - Required. The Rollout which owns this collection of JobRun objects. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/deliveryPipelines/\[^/\]+/releases/\[^/\]+/rollouts/\[^/\]+$.

filter - Optional. Filter results to be returned. See https://google.aip.dev/160 for more details.

orderBy - Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.

pageSize - Optional. The maximum number of JobRun objects to return. The service may return fewer than this value. If unspecified, at most 50 JobRun objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

pageToken - Optional. A page token, received from a previous ListJobRuns call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.

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

Completes with a ListJobRunsResponse.

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

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

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