Method: projects.locations.jobs.list

List the jobs of a project.

To list the jobs of a project in a region, we recommend using projects.locations.jobs.list with a regional endpoint. To list the all jobs across all regions, use projects.jobs.aggregated. Using projects.jobs.list is not recommended, because you can only get the list of jobs that are running in us-central1.

projects.locations.jobs.list and projects.jobs.list support filtering the list of jobs by name. Filtering by name isn't supported by projects.jobs.aggregated.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
projectId

string

The project which owns the jobs.
location

string

The regional endpoint that contains this job.

Query parameters

Parameters
filter

enum (Filter)

The kind of filter to use.
view
(deprecated)

enum (JobView)

Deprecated. jobs.list always returns summaries now. Use jobs.get for other JobViews.
pageSize

integer

If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.
pageToken

string

Set this to the 'nextPageToken' field of a previous response to request additional results in a long list.
name

string

Optional. The job name.

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.