pause method

Future<Job> pause(
  1. PauseJobRequest request,
  2. String name, {
  3. String? $fields,
})

Pauses a job.

If a job is paused then the system will stop executing the job until it is re-enabled via ResumeJob. The state of the job is stored in state; if paused it will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED to be paused.

request - The metadata request object.

Request parameters:

name - Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/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> pause(
  PauseJobRequest 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') + ':pause';

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