gcp_bigquery_dataset

access

Type: UNORDERED_LIST_STRUCT
Provider name: access
Description: [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;

  • dataset
    Type: STRUCT
    Provider name: dataset
    Description: [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation.
    • dataset
      Type: STRUCT
      Provider name: dataset
      Description: [Required] The dataset this entry applies to.
      • dataset_id
        Type: STRING
        Provider name: datasetId
        Description: [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.
      • project_id
        Type: STRING
        Provider name: projectId
        Description: [Optional] The ID of the project containing this dataset.
    • target_types
      Type: UNORDERED_LIST_STRING
      Provider name: targetTypes
  • domain
    Type: STRING
    Provider name: domain
    Description: [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”.
  • group_by_email
    Type: STRING
    Provider name: groupByEmail
    Description: [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member “group:GROUP”.
  • iam_member
    Type: STRING
    Provider name: iamMember
    Description: [Pick one] Some other type of member that appears in the IAM Policy but isn’t a user, group, domain, or special group.
  • role
    Type: STRING
    Provider name: role
    Description: [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”.
  • routine
    Type: STRUCT
    Provider name: routine
    Description: [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation.
    • dataset_id
      Type: STRING
      Provider name: datasetId
      Description: Required. The ID of the dataset containing this routine.
    • project_id
      Type: STRING
      Provider name: projectId
      Description: Required. The ID of the project containing this routine.
    • routine_id
      Type: STRING
      Provider name: routineId
      Description: Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
  • special_group
    Type: STRING
    Provider name: specialGroup
    Description: [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.
  • user_by_email
    Type: STRING
    Provider name: userByEmail
    Description: [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”.
  • view
    Type: STRUCT
    Provider name: view
    Description: [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.
    • dataset_id
      Type: STRING
      Provider name: datasetId
      Description: [Required] The ID of the dataset containing this table.
    • project_id
      Type: STRING
      Provider name: projectId
      Description: [Required] The ID of the project containing this table.
    • table_id
      Type: STRING
      Provider name: tableId
      Description: [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.

ancestors

Type: UNORDERED_LIST_STRING

creation_time

Type: INT64
Provider name: creationTime
Description: [Output-only] The time when this dataset was created, in milliseconds since the epoch.

dataset_reference

Type: STRUCT
Provider name: datasetReference
Description: [Required] A reference that identifies the dataset.

  • dataset_id
    Type: STRING
    Provider name: datasetId
    Description: [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.
  • project_id
    Type: STRING
    Provider name: projectId
    Description: [Optional] The ID of the project containing this dataset.

default_collation

Type: STRING
Provider name: defaultCollation
Description: [Output-only] The default collation of the dataset.

default_encryption_configuration

Type: STRUCT
Provider name: defaultEncryptionConfiguration

  • kms_key_name
    Type: STRING
    Provider name: kmsKeyName
    Description: 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.

default_partition_expiration_ms

Type: INT64
Provider name: defaultPartitionExpirationMs
Description: [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.

default_rounding_mode

Type: STRING
Provider name: defaultRoundingMode
Description: [Output-only] The default rounding mode of the dataset.

default_table_expiration_ms

Type: INT64
Provider name: defaultTableExpirationMs
Description: [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.

description

Type: STRING
Provider name: description
Description: [Optional] A user-friendly description of the dataset.

etag

Type: STRING
Provider name: etag
Description: [Output-only] A hash of the resource.

friendly_name

Type: STRING
Provider name: friendlyName
Description: [Optional] A descriptive name for the dataset.

id

Type: STRING
Provider name: id
Description: [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.

is_case_insensitive

Type: BOOLEAN
Provider name: isCaseInsensitive
Description: [Optional] Indicates if table names are case insensitive in the dataset.

kind

Type: STRING
Provider name: kind
Description: [Output-only] The resource type.

labels

Type: UNORDERED_LIST_STRING

last_modified_time

Type: INT64
Provider name: lastModifiedTime
Description: [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.

location

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

max_time_travel_hours

Type: INT64
Provider name: maxTimeTravelHours
Description: [Optional] Number of hours for the max time travel for all tables in the dataset.

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

satisfies_pzs

Type: BOOLEAN
Provider name: satisfiesPzs
Description: [Output-only] Reserved for future use.

Type: STRING
Provider name: selfLink
Description: [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.

storage_billing_model

Type: STRING
Provider name: storageBillingModel
Description: [Optional] Storage billing model to be used for all tables in the dataset. Can be set to PHYSICAL. Default is LOGICAL.

tags

Type: UNORDERED_LIST_STRING

PREVIEWING: rtrieu/product-analytics-ui-changes