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, as you can only get the
list of jobs that are running in us-central1
.
Arguments
Parameters | |
---|---|
projectId |
Required. The project which owns the jobs.
|
filter |
The kind of filter to use.
|
Enum type. Can be one of the following: | |
UNKNOWN |
The filter isn't specified, or is unknown. This returns all jobs ordered on descending JobUuid . |
ALL |
Returns all running jobs first ordered on creation timestamp, then returns all terminated jobs ordered on the termination timestamp. |
TERMINATED |
Filters the jobs that have a terminated state, ordered on the termination timestamp. Example terminated states: JOB_STATE_STOPPED , JOB_STATE_UPDATED , JOB_STATE_DRAINED , etc. |
ACTIVE |
Filters the jobs that are running ordered on the creation timestamp. |
location |
The regional endpoint that contains this job.
|
pageSize |
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 |
Set this to the 'next_page_token' field of a previous response to request additional results in a long list.
|
view |
Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews.
|
Enum type. Can be one of the following: | |
JOB_VIEW_UNKNOWN |
The job view to return isn't specified, or is unknown. Responses will contain at least the JOB_VIEW_SUMMARY information, and may contain additional information. |
JOB_VIEW_SUMMARY |
Request summary information only: Project ID, Job ID, job name, job type, job status, start/end time, and Cloud SDK version details. |
JOB_VIEW_ALL |
Request all information available for this job. |
JOB_VIEW_DESCRIPTION |
Request summary info and limited job description data for steps, labels and environment. |
Raised exceptions
Exceptions | |
---|---|
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
Response
If successful, the response contains an instance of ListJobsResponse
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- list: call: googleapis.dataflow.v1b3.projects.jobs.list args: projectId: ... filter: ... location: ... pageSize: ... pageToken: ... view: ... result: listResult
JSON
[ { "list": { "call": "googleapis.dataflow.v1b3.projects.jobs.list", "args": { "projectId": "...", "filter": "...", "location": "...", "pageSize": "...", "pageToken": "...", "view": "..." }, "result": "listResult" } } ]