Method: projects.locations.jobs.get

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.

HTTP request

GET https://dataflow.googleapis.com/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
projectId

string

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

location

string

The regional endpoint that contains this job.

jobId

string

The job ID.

Query parameters

Parameters
view

enum(JobView)

The level of information requested in response.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Job.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/userinfo.email

For more information, see the Authentication Overview.

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Dataflow
Need help? Visit our support page.