update method

Future<Job> update(Job request, String projectId, String location, String jobId, { String? $fields, })

Updates the state of an existing Cloud Dataflow job.

To update the state of an existing job, we recommend using projects.locations.jobs.update with a regional endpoint. Using projects.jobs.update is not recommended, as you can only update the state of jobs that are running in us-central1.

request - The metadata request object.

Request parameters:

projectId - The ID of the Cloud Platform project that the job belongs to.

location - The regional endpoint that contains this job.

jobId - The job ID.

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

Completes with a Job.

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<Job> update(
  Job request,
  core.String projectId,
  core.String location,
  core.String jobId, {
  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 = 'v1b3/projects/' +
      commons.escapeVariable('$projectId') +
      '/locations/' +
      commons.escapeVariable('$location') +
      '/jobs/' +
      commons.escapeVariable('$jobId');

  final _response = await _requester.request(
    _url,
    'PUT',
    body: _body,
    queryParams: _queryParams,
  );
  return Job.fromJson(_response as core.Map<core.String, core.dynamic>);
}