- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
- Try it!
List all catalogs in a specified project.
HTTP request
GET https://biglake.googleapis.com/v1alpha1/{parent=projects/*/locations/*}/catalogs
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The parent, which owns this collection of catalogs. Format: projects/{project_id_or_number}/locations/{locationId} |
Query parameters
Parameters | |
---|---|
pageSize |
The maximum number of catalogs to return. The service may return fewer than this value. If unspecified, at most 50 catalogs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
pageToken |
A page token, received from a previous When paginating, all other parameters provided to |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Response message for the catalogs.list method.
JSON representation |
---|
{
"catalogs": [
{
object ( |
Fields | |
---|---|
catalogs[] |
The catalogs from the specified project. |
nextPageToken |
A token, which can be sent as |
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/bigquery
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the parent
resource:
biglake.catalogs.list
For more information, see the IAM documentation.