v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1342194234.5 KB
projects

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] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). 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.

get/v1b3/projects/{projectId}/jobs

Path parameters

projectIdstring required

The project which owns the jobs.

Query parameters

filter'UNKNOWN' | 'ALL' | 'TERMINATED' | 'ACTIVE'

The kind of filter to use.

locationstring

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

namestring

Optional. The job name.

pageSizeinteger

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.

pageTokenstring

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

view'JOB_VIEW_UNKNOWN' | 'JOB_VIEW_SUMMARY' | 'JOB_VIEW_ALL' | 'JOB_VIEW_DESCRIPTION'

Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews.

Response

Successful response