pub struct Dataset {Show 30 fields
pub access: Option<Vec<DatasetAccess>>,
pub creation_time: Option<i64>,
pub dataset_reference: Option<DatasetReference>,
pub default_collation: Option<String>,
pub default_encryption_configuration: Option<EncryptionConfiguration>,
pub default_partition_expiration_ms: Option<i64>,
pub default_rounding_mode: Option<String>,
pub default_table_expiration_ms: Option<i64>,
pub description: Option<String>,
pub etag: Option<String>,
pub external_catalog_dataset_options: Option<ExternalCatalogDatasetOptions>,
pub external_dataset_reference: Option<ExternalDatasetReference>,
pub friendly_name: Option<String>,
pub id: Option<String>,
pub is_case_insensitive: Option<bool>,
pub kind: Option<String>,
pub labels: Option<HashMap<String, String>>,
pub last_modified_time: Option<i64>,
pub linked_dataset_metadata: Option<LinkedDatasetMetadata>,
pub linked_dataset_source: Option<LinkedDatasetSource>,
pub location: Option<String>,
pub max_time_travel_hours: Option<i64>,
pub resource_tags: Option<HashMap<String, String>>,
pub restrictions: Option<RestrictionConfig>,
pub satisfies_pzi: Option<bool>,
pub satisfies_pzs: Option<bool>,
pub self_link: Option<String>,
pub storage_billing_model: Option<String>,
pub tags: Option<Vec<DatasetTags>>,
pub type_: Option<String>,
}Expand description
Represents a BigQuery dataset.
§Activities
This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).
- delete datasets (none)
- get datasets (response)
- insert datasets (request|response)
- list datasets (none)
- patch datasets (request|response)
- undelete datasets (response)
- update datasets (request|response)
Fields§
§access: Option<Vec<DatasetAccess>>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; If you patch a dataset, then this field is overwritten by the patched dataset’s access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add.
creation_time: Option<i64>Output only. The time when this dataset was created, in milliseconds since the epoch.
dataset_reference: Option<DatasetReference>Required. A reference that identifies the dataset.
default_collation: Option<String>Optional. Defines the default collation specification of future tables created in the dataset. If a table is created in this dataset without table-level default collation, then the table inherits the dataset default collation, which is applied to the string fields that do not have explicit collation specified. A change to this field affects only tables created afterwards, and does not alter the existing tables. The following values are supported: * ‘und:ci’: undetermined locale, case insensitive. * ‘’: empty string. Default to case-sensitive behavior.
default_encryption_configuration: Option<EncryptionConfiguration>The default encryption key for all tables in the dataset. After this property is set, the encryption key of all newly-created tables in the dataset is set to this value unless the table creation request or query explicitly overrides the key.
default_partition_expiration_ms: Option<i64>This default partition expiration, expressed in milliseconds. When new time-partitioned tables are created in a dataset where this property is set, the table will inherit this value, propagated as the TimePartitioning.expirationMs property on the new table. If you set TimePartitioning.expirationMs explicitly when creating a table, the defaultPartitionExpirationMs of the containing dataset is ignored. When creating a partitioned table, if defaultPartitionExpirationMs is set, the defaultTableExpirationMs value is ignored and the table will not be inherit a table expiration deadline.
default_rounding_mode: Option<String>Optional. Defines the default rounding mode specification of new tables created within this dataset. During table creation, if this field is specified, the table within this dataset will inherit the default rounding mode of the dataset. Setting the default rounding mode on a table overrides this option. Existing tables in the dataset are unaffected. If columns are defined during that table creation, they will immediately inherit the table’s default rounding mode, unless otherwise specified.
default_table_expiration_ms: Option<i64>Optional. The default lifetime of all tables in the dataset, in milliseconds. The minimum lifetime value is 3600000 milliseconds (one hour). To clear an existing default expiration with a PATCH request, set to 0. 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: Option<String>Optional. A user-friendly description of the dataset.
etag: Option<String>Output only. A hash of the resource.
external_catalog_dataset_options: Option<ExternalCatalogDatasetOptions>Optional. Options defining open source compatible datasets living in the BigQuery catalog. Contains metadata of open source database, schema or namespace represented by the current dataset.
external_dataset_reference: Option<ExternalDatasetReference>Optional. Reference to a read-only external dataset defined in data catalogs outside of BigQuery. Filled out when the dataset type is EXTERNAL.
friendly_name: Option<String>Optional. A descriptive name for the dataset.
id: Option<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.
is_case_insensitive: Option<bool>Optional. TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. By default, this is FALSE, which means the dataset and its table names are case-sensitive. This field does not affect routine references.
kind: Option<String>Output only. The resource type.
labels: Option<HashMap<String, 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.
last_modified_time: Option<i64>Output only. The date when this dataset was last modified, in milliseconds since the epoch.
linked_dataset_metadata: Option<LinkedDatasetMetadata>Output only. Metadata about the LinkedDataset. Filled out when the dataset type is LINKED.
linked_dataset_source: Option<LinkedDatasetSource>Optional. The source dataset reference when the dataset is of type LINKED. For all other dataset types it is not set. This field cannot be updated once it is set. Any attempt to update this field using Update and Patch API Operations will be ignored.
location: Option<String>The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
max_time_travel_hours: Option<i64>Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set.
Optional. The tags attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example “123456789012/environment” where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example “Production”. See Tag definitions for more details.
restrictions: Option<RestrictionConfig>Optional. Output only. Restriction config for all tables and dataset. If set, restrict certain accesses on the dataset and all its tables based on the config. See Data egress for more details.
satisfies_pzi: Option<bool>Output only. Reserved for future use.
satisfies_pzs: Option<bool>Output only. Reserved for future use.
self_link: Option<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.
storage_billing_model: Option<String>Optional. Updates storage_billing_model for the dataset.
Output only. Tags for the dataset. To provide tags as inputs, use the resourceTags field.
type_: Option<String>Output only. Same as type in ListFormatDataset. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog.