Updates information in an existing dataset. The update method replaces
the entire dataset resource, whereas the patch method only replaces
fields that are provided in the submitted dataset resource. This method
supports RFC5789 patch semantics. # IAM Permissions Requires the
following IAM permission(s) to use this method: -
bigquery.datasets.update on the dataset. - bigquery.datasets.get on
the dataset.
Arguments
| Parameters | |
|---|---|
datasetId |
Required. Dataset ID of the dataset being updated |
projectId |
Required. Project ID of the dataset being updated |
accessPolicyVersion |
Optional. The version of the provided access policy schema. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. This version refers to the schema version of the access policy and not the version of access policy. This field's value can be equal or more than the access policy schema provided in the request. For example, * Operations updating conditional access policy binding in datasets must specify version 3. Some of the operations are : - Adding a new access policy entry with condition. - Removing an access policy entry with condition. - Updating an access policy entry with condition. * But dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. If unset or if 0 or 1 value is used for dataset with conditional bindings, request will be rejected. This field will be mapped to IAM Policy version (https://cloud.google.com/iam/docs/policies#versions) and will be used to set policy in IAM. |
updateMode |
Optional. Specifies the fields of dataset that update/patch operation is targeting By default, both metadata and ACL fields are updated. |
| Enum type. Can be one of the following: | |
UPDATE_MODE_UNSPECIFIED |
The default value. Default to the UPDATE_FULL. |
UPDATE_METADATA |
Includes metadata information for the dataset, such as friendlyName, description, labels, etc. |
UPDATE_ACL |
Includes ACL information for the dataset, which defines dataset access for one or more entities. |
UPDATE_FULL |
Includes both dataset metadata and ACL information. |
body |
Required. |
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
- patch: call: googleapis.bigquery.v2.datasets.patch args: datasetId: ... projectId: ... accessPolicyVersion: ... updateMode: ... body: access: condition: description: ... expression: ... location: ... title: ... dataset: dataset: datasetId: ... projectId: ... targetTypes: ... domain: ... groupByEmail: ... iamMember: ... role: ... routine: datasetId: ... projectId: ... routineId: ... specialGroup: ... userByEmail: ... view: datasetId: ... projectId: ... tableId: ... datasetReference: ... defaultCollation: ... defaultEncryptionConfiguration: kmsKeyName: ... defaultPartitionExpirationMs: ... defaultRoundingMode: ... defaultTableExpirationMs: ... description: ... externalCatalogDatasetOptions: defaultStorageLocationUri: ... parameters: ... externalDatasetReference: connection: ... externalSource: ... friendlyName: ... isCaseInsensitive: ... labels: ... linkedDatasetSource: sourceDataset: ... location: ... maxTimeTravelHours: ... resourceTags: ... storageBillingModel: ... result: patchResult
JSON
[ { "patch": { "call": "googleapis.bigquery.v2.datasets.patch", "args": { "datasetId": "...", "projectId": "...", "accessPolicyVersion": "...", "updateMode": "...", "body": { "access": { "condition": { "description": "...", "expression": "...", "location": "...", "title": "..." }, "dataset": { "dataset": { "datasetId": "...", "projectId": "..." }, "targetTypes": "..." }, "domain": "...", "groupByEmail": "...", "iamMember": "...", "role": "...", "routine": { "datasetId": "...", "projectId": "...", "routineId": "..." }, "specialGroup": "...", "userByEmail": "...", "view": { "datasetId": "...", "projectId": "...", "tableId": "..." } }, "datasetReference": "...", "defaultCollation": "...", "defaultEncryptionConfiguration": { "kmsKeyName": "..." }, "defaultPartitionExpirationMs": "...", "defaultRoundingMode": "...", "defaultTableExpirationMs": "...", "description": "...", "externalCatalogDatasetOptions": { "defaultStorageLocationUri": "...", "parameters": "..." }, "externalDatasetReference": { "connection": "...", "externalSource": "..." }, "friendlyName": "...", "isCaseInsensitive": "...", "labels": "...", "linkedDatasetSource": { "sourceDataset": "..." }, "location": "...", "maxTimeTravelHours": "...", "resourceTags": "...", "storageBillingModel": "..." } }, "result": "patchResult" } } ]