DatasetArgs class

The set of arguments for Dataset. The set of arguments for Dataset.

Constructors

DatasetArgs({Input<List<DatasetAccess>?>? accesses, required Input<String> datasetId, Input<String?>? defaultCollation, Input<DatasetDefaultEncryptionConfiguration?>? defaultEncryptionConfiguration, Input<int?>? defaultPartitionExpirationMs, Input<int?>? defaultTableExpirationMs, Input<bool?>? deleteContentsOnDestroy, Input<String?>? deletionPolicy, Input<String?>? description, Input<DatasetExternalCatalogDatasetOptions?>? externalCatalogDatasetOptions, Input<DatasetExternalDatasetReference?>? externalDatasetReference, Input<String?>? friendlyName, Input<bool?>? isCaseInsensitive, Input<Map<String, String>?>? labels, Input<String?>? location, Input<String?>? maxTimeTravelHours, Input<String?>? project, Input<Map<String, String>?>? resourceTags, Input<String?>? storageBillingModel})
Creates a new DatasetArgs. accesses An array of objects that define dataset access for one or more entities. datasetId A unique ID for this dataset, without the project name. The ID defaultCollation Defines the default collation specification of future tables created defaultEncryptionConfiguration The default encryption key for all tables in the dataset. Once this property is set, defaultPartitionExpirationMs The default partition expiration for all partitioned tables in defaultTableExpirationMs The default lifetime of all tables in the dataset, in milliseconds. deleteContentsOnDestroy If set to true, delete all the tables in the deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. description A user-friendly description of the dataset externalCatalogDatasetOptions Options defining open source compatible datasets living in the BigQuery catalog. Contains externalDatasetReference Information about the external metadata storage where the dataset is defined. friendlyName A descriptive name for the dataset isCaseInsensitive TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. labels The labels associated with this dataset. You can use these to location The geographic location where the dataset should reside. maxTimeTravelHours Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). project The ID of the project in which the resource belongs. resourceTags The tags attached to this table. Tag keys are globally unique. Tag key is expected to be storageBillingModel Specifies the storage billing model for the dataset.
const
DatasetArgs.fromMap(Map<String, dynamic> map)
factory

Properties

accesses → Input<List<DatasetAccess>?>?
An array of objects that define dataset access for one or more entities. Structure is documented below.
final
datasetId → Input<String>
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.
final
defaultCollation → Input<String?>?
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:
final
defaultEncryptionConfiguration → Input<DatasetDefaultEncryptionConfiguration?>?
The default encryption key for all tables in the dataset. Once this property is set, all newly-created partitioned tables in the dataset will have encryption key set to this value, unless table creation request (or query) overrides the key. Structure is documented below.
final
defaultPartitionExpirationMs → Input<int?>?
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.
final
defaultTableExpirationMs → Input<int?>?
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.
final
deleteContentsOnDestroy → Input<bool?>?
If set to true, delete all the tables in the dataset when destroying the resource; otherwise, destroying the resource will fail if tables are present.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
description → Input<String?>?
A user-friendly description of the dataset
final
externalCatalogDatasetOptions → Input<DatasetExternalCatalogDatasetOptions?>?
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. Structure is documented below.
final
externalDatasetReference → Input<DatasetExternalDatasetReference?>?
Information about the external metadata storage where the dataset is defined. Structure is documented below.
final
friendlyName → Input<String?>?
A descriptive name for the dataset
final
hashCode → int
The hash code for this object.
no setterinherited
isCaseInsensitive → Input<bool?>?
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.
final
labels → Input<Map<String, String>?>?
The labels associated with this dataset. You can use these to organize and group your datasets.
final
location → Input<String?>?
The geographic location where the dataset should reside. See official docs. There are two types of locations, regional or multi-regional. A regional location is a specific geographic place, such as Tokyo, and a multi-regional location is a large geographic area, such as the United States, that contains at least two geographic places. The default value is multi-regional location US. Changing this forces a new resource to be created.
final
maxTimeTravelHours → Input<String?>?
Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days).
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
resourceTags → Input<Map<String, String>?>?
The tags attached to this table. 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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
storageBillingModel → Input<String?>?
Specifies the storage billing model for the dataset. Set this flag value to LOGICAL to use logical bytes for storage billing, or to PHYSICAL to use physical bytes instead. LOGICAL is the default if this flag isn't specified.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited