patch method

Future<TransferJob> patch(
  1. UpdateTransferJobRequest request,
  2. String jobName, {
  3. String? $fields,
})

Updates a transfer job.

Updating a job's transfer spec does not affect transfer operations that are running already. Note: The job's status field can be modified using this RPC (for example, to set a job's status to DELETED, DISABLED, or ENABLED).

request - The metadata request object.

Request parameters:

jobName - Required. The name of job to update. Value must have pattern ^transferJobs/.*$.

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

Completes with a TransferJob.

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<TransferJob> patch(
  UpdateTransferJobRequest request,
  core.String jobName, {
  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('$jobName');

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