stop method

Future<GoogleCloudDatapipelinesV1Pipeline> stop(
  1. GoogleCloudDatapipelinesV1StopPipelineRequest request,
  2. String name, {
  3. String? $fields,
})

Freezes pipeline execution permanently.

If there's a corresponding scheduler entry, it's deleted, and the pipeline state is changed to "ARCHIVED". However, pipeline metadata is retained.

request - The metadata request object.

Request parameters:

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

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

Completes with a GoogleCloudDatapipelinesV1Pipeline.

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<GoogleCloudDatapipelinesV1Pipeline> stop(
  GoogleCloudDatapipelinesV1StopPipelineRequest request,
  core.String name, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name') + ':stop';

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