Method: projects.regions.jobs.list

HTTP request
Path parameters
Query parameters
Request body
Response body
- JSON representation
Authorization scopes
JobStateMatcher
Try it!

Lists regions/{region}/jobs in a project.

HTTP request

GET https://dataproc.googleapis.com/v1/projects/{projectId}/regions/{region}/jobs

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

projectId

string

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

Authorization requires the following IAM permission on the specified resource projectId :

dataproc.jobs.list

region

string

Required. The Dataproc region in which to handle the request.

Query parameters

Parameters
`pageSize`	`integer` Optional. The number of results to return in each response.
`pageToken`	`string` Optional. The page token, returned by a previous call, to request the next page of results.
`clusterName`	`string` Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.
`jobStateMatcher`	`enum ( JobStateMatcher )` Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs). If `filter` is provided, `jobStateMatcher` will be ignored.
`filter`	`string` Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax: [field = value] AND [field [= value]] ... where fieldis `status.state` or `labels.[KEY]` , and `[KEY]` is a label key. valuecan be `` to match all values. `status.state` can be either `ACTIVE` or `NON_ACTIVE` . Only the logical `AND` operator is supported; space-separated items are treated as having an implicit `AND` operator. Example filter: status.state = ACTIVE AND labels.env = staging AND labels.starred =

Request body

The request body must be empty.

Response body

A list of jobs in a project.

If successful, the response body contains data with the following structure:

JSON representation
{ "jobs" : [ { object ( `Job` ) } ] , "nextPageToken" : string , "unreachable" : [ string ] }

Fields

Fields
`jobs[]`	`object ( Job )` Output only. Jobs list.
`nextPageToken`	`string` Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the `pageToken` in a subsequent `ListJobsRequest` .
`unreachable[]`	`string` Output only. List of jobs with `kmsKey` -encrypted parameters that could not be decrypted. A response to a `jobs.get` request may indicate the reason for the decryption failure for a specific job.

jobs[]

object ( Job )

Output only. Jobs list.

nextPageToken

string

Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the pageToken in a subsequent

ListJobsRequest

unreachable[]

string

Output only. List of jobs with kmsKey -encrypted parameters that could not be decrypted. A response to a jobs.get request may indicate the reason for the decryption failure for a specific job.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview .

JobStateMatcher

A matcher that specifies categories of job states.

Enums
`ALL`	Match all jobs, regardless of state.
`ACTIVE`	Only match jobs in non-terminal states: PENDING, RUNNING, or CANCEL_PENDING.
`NON_ACTIVE`	Only match jobs in terminal states: CANCELLED, DONE, or ERROR.