Console
Start free

Method: googleapis.bigquery.v2.routines.list

Lists all routines in the specified dataset. Requires the READER dataset role.

Arguments

Parameters datasetId

string

Required. Dataset ID of the routines to list

projectId

string

Required. Project ID of the routines to list

filter

string

If set, then only the Routines matching this filter are returned. The current supported form is either "routine_type:" or "routineType:", where is a RoutineType enum. Example: "routineType:SCALAR_FUNCTION".

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

readMask

string (FieldMask format)

If set, then only the Routine fields in the field mask, as well as project_id, dataset_id and routine_id, are returned in the response. If unset, then the following Routine fields are returned: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language.

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

Subworkflow snippet

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

YAML

- list:
    call: googleapis.bigquery.v2.routines.list
    args:
        datasetId: ...
        projectId: ...
        filter: ...
        maxResults: ...
        pageToken: ...
        readMask: ...
    result: listResult

JSON

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