Bigquery.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.

PUT/projects/{projectId}/datasets/{datasetId}

Use it in a workflow

Add a step and choose the BigQuery connector.
Pick the Bigquery.datasets.update action (under datasets).
Fill in the fields below, then reference the result from later steps as {{bigqueryDatasetsUpdate.response.data}}.

Request

Path parameters

projectIdstringrequired

Project ID of the dataset being updated

datasetIdstringrequired

Dataset ID of the dataset being updated

Query parameters

altstring

Data format for the response.

One ofjson

fieldsstring

Selector specifying which fields to include in a partial response.

keystring

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_tokenstring

OAuth 2.0 token for the current user.

prettyPrintboolean

Returns response with indentations and line breaks.

quotaUserstring

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIpstring

Deprecated. Please use quotaUser instead.

Request body

Enter the body as JSON in the step's Body field.

accessarray<object>

[Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;

datasetobject2 fields

domainstring

[Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN".

groupByEmailstring

[Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".

iamMemberstring

[Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.

rolestring

[Required] An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: OWNER roles/bigquery.dataOwner WRITER roles/bigquery.dataEditor READER roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER".

routineobject3 fields

specialGroupstring

[Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.

userByEmailstring

[Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL".

viewobject3 fields

creationTimestring (int64)

[Output-only] The time when this dataset was created, in milliseconds since the epoch.

datasetReferenceobject

datasetIdstring

[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.

projectIdstring

[Optional] The ID of the project containing this dataset.

defaultCollationstring

[Output-only] The default collation of the dataset.

defaultEncryptionConfigurationobject

kmsKeyNamestring

[Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

defaultPartitionExpirationMsstring (int64)

[Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.

defaultRoundingModestring

[Output-only] The default rounding mode of the dataset.

defaultTableExpirationMsstring (int64)

[Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.

descriptionstring

[Optional] A user-friendly description of the dataset.

etagstring

[Output-only] A hash of the resource.

friendlyNamestring

[Optional] A descriptive name for the dataset.

idstring

[Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.

isCaseInsensitiveboolean

[Optional] Indicates if table names are case insensitive in the dataset.

kindstring

[Output-only] The resource type.

Default "bigquery#dataset"

labelsobject

The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.

lastModifiedTimestring (int64)

[Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.

locationstring

The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.

maxTimeTravelHoursstring (int64)

[Optional] Number of hours for the max time travel for all tables in the dataset.

satisfiesPzsboolean

[Output-only] Reserved for future use.

selfLinkstring

[Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.

storageBillingModelstring

[Optional] Storage billing model to be used for all tables in the dataset. Can be set to PHYSICAL. Default is LOGICAL.

tagsarray<object>

[Optional]The tags associated with this dataset. Tag keys are globally unique.

tagKeystring

[Required] The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id.

tagValuestring

[Required] Friendly short name of the tag value, e.g. "production".

json

{
  "access": [
    {
      "dataset": {
        "dataset": {
          "datasetId": "string",
          "projectId": "string"
        },
        "targetTypes": [
          "TARGET_TYPE_UNSPECIFIED"
        ]
      },
      "domain": "string",
      "groupByEmail": "string",
      "iamMember": "string",
      "role": "string",
      "routine": {
        "datasetId": "string",
        "projectId": "string",
        "routineId": "string"
      },
      "specialGroup": "string",
      "userByEmail": "string",
      "view": {
        "datasetId": "string",
        "projectId": "string",
        "tableId": "string"
      }
    }
  ],
  "creationTime": "string",
  "datasetReference": {
    "datasetId": "string",
    "projectId": "string"
  },
  "defaultCollation": "string",
  "defaultEncryptionConfiguration": {
    "kmsKeyName": "string"
  },
  "defaultPartitionExpirationMs": "string",
  "defaultRoundingMode": "string",
  "defaultTableExpirationMs": "string",
  "description": "string",
  "etag": "string",
  "friendlyName": "string",
  "id": "string"
}

Response

Returns 200 with an object. Read it in later steps with {{bigqueryDatasetsUpdate.response.data.<field>}}.