List
|
|||||
|
|
Lists all datasets in the specified project to which you have been granted the READER dataset role
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data in Google BigQuery
- View and manage your data across Google Cloud Platform services
- View your data across Google Cloud Platform services
Input
This building block consumes 5 input parameters
Name | Format | Description |
---|---|---|
projectId Required |
STRING |
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. |
pageToken |
STRING |
Page token, returned by a previous call, to request the next page of results |
maxResults |
INTEGER |
The maximum number of results to return |
= Parameter name
= Format
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. |
pageToken STRING Page token, returned by a previous call, to request the next page of results |
maxResults INTEGER The maximum number of results to return |
Output
This building block provides 13 output parameters
Name | Format | Description |
---|---|---|
datasets[] |
OBJECT |
|
datasets[].id |
STRING |
The fully-qualified, unique, opaque ID of the dataset |
datasets[].location |
STRING |
The geographic location where the data resides |
datasets[].friendlyName |
STRING |
A descriptive name for the dataset, if one exists |
datasets[].kind |
STRING |
The resource type. This property always returns the value "bigquery#dataset" |
datasets[].labels |
OBJECT |
The labels associated with this dataset. You can use these to organize and group your datasets |
datasets[].labels.customKey.value |
STRING |
The labels associated with this dataset. You can use these to organize and group your datasets |
datasets[].datasetReference |
OBJECT |
|
datasets[].datasetReference.projectId |
STRING |
[Optional] The ID of the project containing this dataset |
datasets[].datasetReference.datasetId |
STRING |
[Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters |
nextPageToken |
STRING |
A token that can be used to request the next results page. This property is omitted on the final results page |
kind |
STRING |
The list type. This property always returns the value "bigquery#datasetList" |
etag |
STRING |
A hash value of the results page. You can use this property to determine if the page has changed since the last request |
= Parameter name
= Format
datasets[] OBJECT |
datasets[].id STRING The fully-qualified, unique, opaque ID of the dataset |
datasets[].location STRING The geographic location where the data resides |
datasets[].friendlyName STRING A descriptive name for the dataset, if one exists |
datasets[].kind STRING The resource type. This property always returns the value "bigquery#dataset" |
datasets[].labels OBJECT The labels associated with this dataset. You can use these to organize and group your datasets |
datasets[].labels.customKey.value STRING The labels associated with this dataset. You can use these to organize and group your datasets |
datasets[].datasetReference OBJECT |
datasets[].datasetReference.projectId STRING [Optional] The ID of the project containing this dataset |
datasets[].datasetReference.datasetId STRING [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters |
nextPageToken STRING A token that can be used to request the next results page. This property is omitted on the final results page |
kind STRING The list type. This property always returns the value "bigquery#datasetList" |
etag STRING A hash value of the results page. You can use this property to determine if the page has changed since the last request |