get method

Future<Job> get(
  1. String projectId,
  2. String jobId, {
  3. String? location,
  4. String? view,
  5. String? $fields,
})

Gets the state of the specified Cloud Dataflow job.

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

Request parameters:

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

jobId - The job ID.

location - The regional endpoint that contains this job.

view - The level of information requested in response. Possible string values are:

  • "JOB_VIEW_UNKNOWN" : The job view to return isn't specified, or is unknown. Responses will contain at least the JOB_VIEW_SUMMARY information, and may contain additional information.
  • "JOB_VIEW_SUMMARY" : Request summary information only: Project ID, Job ID, job name, job type, job status, start/end time, and Cloud SDK version details.
  • "JOB_VIEW_ALL" : Request all information available for this job. When the job is in JOB_STATE_PENDING, the job has been created but is not yet running, and not all job information is available. For complete job information, wait until the job in is JOB_STATE_RUNNING. For more information, see JobState.
  • "JOB_VIEW_DESCRIPTION" : Request summary info and limited job description data for steps, labels and environment.

$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> get(
  core.String projectId,
  core.String jobId, {
  core.String? location,
  core.String? view,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (location != null) 'location': [location],
    if (view != null) 'view': [view],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1b3/projects/' +
      commons.escapeVariable('$projectId') +
      '/jobs/' +
      commons.escapeVariable('$jobId');

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