list method

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

Lists pipelines.

Returns a "FORBIDDEN" error if the caller doesn't have permission to access it.

Request parameters:

parent - Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - An expression for filtering the results of the request. If unspecified, all pipelines will be returned. Multiple filters can be applied and must be comma separated. Fields eligible for filtering are: + type: The type of the pipeline (streaming or batch). Allowed values are ALL, BATCH, and STREAMING. + status: The activity status of the pipeline. Allowed values are ALL, ACTIVE, ARCHIVED, and PAUSED. For example, to limit results to active batch processing pipelines: type:BATCH,status:ACTIVE

pageSize - The maximum number of entities to return. The service may return fewer than this value, even if there are additional pages. If unspecified, the max limit is yet to be determined by the backend implementation.

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

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

Completes with a GoogleCloudDatapipelinesV1ListPipelinesResponse.

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

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

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