list method

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

Lists Automations in a given project and location.

Request parameters:

parent - Required. The parent Delivery Pipeline, which owns this collection of automations. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/deliveryPipelines/\[^/\]+$.

filter - Filter automations to be returned. All fields can be used in the filter.

orderBy - Field to sort by.

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

pageToken - A page token, received from a previous ListAutomations 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 ListAutomationsResponse.

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<ListAutomationsResponse> 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>>{
    'filter': ?filter == null ? null : [filter],
    'orderBy': ?orderBy == null ? null : [orderBy],
    'pageSize': ?pageSize == null ? null : ['${pageSize}'],
    'pageToken': ?pageToken == null ? null : [pageToken],
    'fields': ?$fields == null ? null : [$fields],
  };

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

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