Returns the dataset specified by datasetID. # IAM Permissions Requires
the bigquery.datasets.get permission on the dataset.
Arguments
| Parameters | |
|---|---|
datasetId |
Required. Dataset ID of the requested dataset |
projectId |
Required. Project ID of the requested dataset |
accessPolicyVersion |
Optional. The version of the access policy schema to fetch. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for conditional access policy binding in datasets must specify version 3. Dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. This field will be mapped to IAM Policy version and will be used to fetch policy from IAM. If unset or if 0 or 1 value is used for dataset with conditional bindings, access entry with condition will have role string appended by 'withcond' string followed by a hash value. For example : { "access": [ { "role": "roles/bigquery.dataViewer_with_conditionalbinding_7a34awqsda", "userByEmail": "user@example.com", } ] } Please refer https://cloud.google.com/iam/docs/troubleshooting-withcond for more details. |
datasetView |
Optional. Specifies the view that determines which dataset information is returned. By default, metadata and ACL information are returned. |
| Enum type. Can be one of the following: | |
DATASET_VIEW_UNSPECIFIED |
The default value. Default to the FULL view. |
METADATA |
View metadata information for the dataset, such as friendlyName, description, labels, etc. |
ACL |
View ACL information for the dataset, which defines dataset access for one or more entities. |
FULL |
View both dataset metadata and ACL information. |
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 Dataset.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- get: call: googleapis.bigquery.v2.datasets.get args: datasetId: ... projectId: ... accessPolicyVersion: ... datasetView: ... result: getResult
JSON
[ { "get": { "call": "googleapis.bigquery.v2.datasets.get", "args": { "datasetId": "...", "projectId": "...", "accessPolicyVersion": "...", "datasetView": "..." }, "result": "getResult" } } ]