run method

Future<GoogleCloudDatapipelinesV1RunPipelineResponse> run(
  1. GoogleCloudDatapipelinesV1RunPipelineRequest request,
  2. String name, {
  3. String? $fields,
})

Creates a job for the specified pipeline directly.

You can use this method when the internal scheduler is not configured and you want to trigger the job directly or through an external system. Returns a "NOT_FOUND" error if the pipeline doesn't exist. Returns a "FORBIDDEN" error if the user doesn't have permission to access the pipeline or run jobs for the pipeline.

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 GoogleCloudDatapipelinesV1RunPipelineResponse.

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<GoogleCloudDatapipelinesV1RunPipelineResponse> run(
  GoogleCloudDatapipelinesV1RunPipelineRequest 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') + ':run';

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