patch method

Future<GoogleCloudDatapipelinesV1Pipeline> patch(
  1. GoogleCloudDatapipelinesV1Pipeline request,
  2. String name, {
  3. String? updateMask,
  4. String? $fields,
})

Updates a pipeline.

If successful, the updated Pipeline is returned. Returns NOT_FOUND if the pipeline doesn't exist. If UpdatePipeline does not return successfully, you can retry the UpdatePipeline request until you receive a successful response.

request - The metadata request object.

Request parameters:

name - The pipeline name. For example: projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID. * PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and periods (.). For more information, see Identifying projects.

  • LOCATION_ID is the canonical ID for the pipeline's location. The list of available locations can be obtained by calling google.cloud.location.Locations.ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in App Engine regions. * PIPELINE_ID is the ID of the pipeline. Must be unique for the selected project and location. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/pipelines/\[^/\]+$.

updateMask - The list of fields to be updated.

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

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

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