GOgoogle
projects

GET /v1b3/projects/{projectId}/locations/{location}/jobs

Changed on

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. # IAM Permissions Requires the dataflow.jobs.list permission on the project.

Request

  • Base URL
    https://dataflow.googleapis.com
  • Auth
    • OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/cloud-platform
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/cloud-platform
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/compute
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/compute
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdstring required

The project which owns the jobs.

locationstring required

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

Query parameters

createTimeRange.endTimestring google-datetime

Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.

createTimeRange.startTimestring google-datetime

Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.

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

The kind of filter to use.

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.

regionalFanoutRequestedboolean

Optional.

terminationTimeRange.endTimestring google-datetime

Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.

terminationTimeRange.startTimestring google-datetime

Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.

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

nextPageTokenstring

Set if there may be more results than fit in this response.

Changes

  • 69a3fb1fef85Revision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2c

    • info

      added the new optional query request parameter createTimeRange.endTime

    • info

      added the new optional query request parameter createTimeRange.startTime

    • info

      added the new optional query request parameter terminationTimeRange.endTime

    • info

      added the new optional query request parameter terminationTimeRange.startTime

  • e94d44227b2eRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2c