Method: googleapis.bigquery.v2.datasets.list

Lists all datasets in the specified project to which the user has been granted the READER dataset role. # IAM Permissions Requires no specific IAM permission(s) to use this method. Results are filtered to only include datasets on which the caller has the bigquery.datasets.get permission.

Arguments

Parameters
projectId

string

Required. Project ID of the datasets to be listed

all

boolean

Whether to list all datasets, including hidden ones

filter

string

An expression for filtering the results of the request by label. The syntax is labels.[:]. Multiple filters can be AND-ed together by connecting with a space. Example: labels.department:receiving labels.active. See Filtering datasets using labels for details.

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.

pageToken

string

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

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

Subworkflow snippet

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

YAML

- list:
    call: googleapis.bigquery.v2.datasets.list
    args:
        projectId: ...
        all: ...
        filter: ...
        maxResults: ...
        pageToken: ...
    result: listResult

JSON

[
  {
    "list": {
      "call": "googleapis.bigquery.v2.datasets.list",
      "args": {
        "projectId": "...",
        "all": "...",
        "filter": "...",
        "maxResults": "...",
        "pageToken": "..."
      },
      "result": "listResult"
    }
  }
]