Get

Returns the dataset specified by datasetID

2 variables
27 variables

Returns the dataset specified by datasetID

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 2 input parameters

  = Parameter name
  = Format

projectId STRING Required

Project ID of the requested dataset

datasetId STRING Required

Dataset ID of the requested dataset

Output

This building block provides 27 output parameters

  = Parameter name
  = Format

lastModifiedTime INTEGER

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

labels OBJECT

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

labels.customKey.value STRING

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

selfLink STRING

[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

defaultPartitionExpirationMs INTEGER

[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

access[] OBJECT

access[].role STRING

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

access[].view OBJECT

access[].view.tableId STRING

[Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters

access[].view.projectId STRING

[Required] The ID of the project containing this table

access[].view.datasetId STRING

[Required] The ID of the dataset containing this table

access[].groupByEmail STRING

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

access[].domain STRING

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

access[].userByEmail STRING

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

access[].iamMember STRING

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

access[].specialGroup STRING

[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

kind STRING

[Output-only] The resource type

description STRING

[Optional] A user-friendly description of the dataset

defaultTableExpirationMs INTEGER

[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

etag STRING

[Output-only] A hash of the resource

creationTime INTEGER

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

datasetReference OBJECT

datasetReference.projectId STRING

[Optional] The ID of the project containing this dataset

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

id STRING

[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

location STRING

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

friendlyName STRING

[Optional] A descriptive name for the dataset