patch method
Updates specified job.
Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes.
request
- The metadata request object.
Request parameters:
name
- Required during job update. The resource name for the job. This
is generated by the service when a job is created. The format is
"projects/{project_id}/jobs/{job_id}", for example,
"projects/api-test-project/jobs/1234". Use of this field in job queries
and API calls is preferred over the use of requisition_id since this value
is unique.
Value must have pattern ^projects/\[^/\]+/jobs/\[^/\]+$
.
$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> patch(
UpdateJobRequest 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_ = 'v3/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'PATCH',
body: body_,
queryParams: queryParams_,
);
return Job.fromJson(response_ as core.Map<core.String, core.dynamic>);
}