Method: googleapis.bigquery.v2.datasets.update

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.

Arguments

Parameters
datasetId

string

Required. Dataset ID of the dataset being updated
projectId

string

Required. Project ID of the dataset being updated
body

object (Dataset)

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

- update:
    call: googleapis.bigquery.v2.datasets.update
    args:
        datasetId: ...
        projectId: ...
        body:
            access:
                dataset:
                    dataset:
                        datasetId: ...
                        projectId: ...
                    targetTypes: ...
                domain: ...
                groupByEmail: ...
                iamMember: ...
                role: ...
                routine:
                    datasetId: ...
                    projectId: ...
                    routineId: ...
                specialGroup: ...
                userByEmail: ...
                view:
                    datasetId: ...
                    projectId: ...
                    tableId: ...
            datasetReference: ...
            defaultEncryptionConfiguration:
                kmsKeyName: ...
            defaultPartitionExpirationMs: ...
            defaultTableExpirationMs: ...
            description: ...
            friendlyName: ...
            isCaseInsensitive: ...
            labels: ...
            location: ...
            maxTimeTravelHours: ...
            tags:
                tagKey: ...
                tagValue: ...
    result: updateResult

JSON

[
  {
    "update": {
      "call": "googleapis.bigquery.v2.datasets.update",
      "args": {
        "datasetId": "...",
        "projectId": "...",
        "body": {
          "access": {
            "dataset": {
              "dataset": {
                "datasetId": "...",
                "projectId": "..."
              },
              "targetTypes": "..."
            },
            "domain": "...",
            "groupByEmail": "...",
            "iamMember": "...",
            "role": "...",
            "routine": {
              "datasetId": "...",
              "projectId": "...",
              "routineId": "..."
            },
            "specialGroup": "...",
            "userByEmail": "...",
            "view": {
              "datasetId": "...",
              "projectId": "...",
              "tableId": "..."
            }
          },
          "datasetReference": "...",
          "defaultEncryptionConfiguration": {
            "kmsKeyName": "..."
          },
          "defaultPartitionExpirationMs": "...",
          "defaultTableExpirationMs": "...",
          "description": "...",
          "friendlyName": "...",
          "isCaseInsensitive": "...",
          "labels": "...",
          "location": "...",
          "maxTimeTravelHours": "...",
          "tags": {
            "tagKey": "...",
            "tagValue": "..."
          }
        }
      },
      "result": "updateResult"
    }
  }
]