Method: googleapis.bigquery.v2.jobs.list

Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property. # IAM Permissions Requires no specific IAM permission(s) to use this method. Users are able to list the jobs they created. Additional access is granted based on the following permissions: - Users with the bigquery.jobs.listAll permission can list all jobs with all metadata. - Users with the bigquery.jobs.list permission can list all jobs, but with redacted information for jobs they did not create.

Arguments

Parameters
projectId

string

Required. Project ID of the jobs to list.
allUsers

boolean

Whether to display jobs owned by all users in the project. Default False.
maxCreationTime

string (uint64 format)

Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned.
maxResults

integer (uint32 format)

The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
minCreationTime

string (uint64 format)

Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned.
pageToken

string

Page token, returned by a previous call, to request the next page of results.
parentJobId

string

If set, show only child jobs of the specified parent. Otherwise, show all top-level jobs.
projection

enum

Restrict information returned to a set of selected fields
Enum type. Can be one of the following:
full Includes all job data
minimal Does not include the job configuration
stateFilter

enum

Filter for job state
Enum type. Can be one of the following:
done Finished jobs
pending Pending jobs
running Running jobs

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 JobList.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- list:
    call: googleapis.bigquery.v2.jobs.list
    args:
        projectId: ...
        allUsers: ...
        maxCreationTime: ...
        maxResults: ...
        minCreationTime: ...
        pageToken: ...
        parentJobId: ...
        projection: ...
        stateFilter: ...
    result: listResult

JSON

[
  {
    "list": {
      "call": "googleapis.bigquery.v2.jobs.list",
      "args": {
        "projectId": "...",
        "allUsers": "...",
        "maxCreationTime": "...",
        "maxResults": "...",
        "minCreationTime": "...",
        "pageToken": "...",
        "parentJobId": "...",
        "projection": "...",
        "stateFilter": "..."
      },
      "result": "listResult"
    }
  }
]