DatasetArgs class

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

Constructors

DatasetArgs({Input<List<DatasetAccessItem>>? access, Input<DatasetReference>? datasetReference, Input<EncryptionConfiguration>? defaultEncryptionConfiguration, Input<String>? defaultPartitionExpirationMs, Input<String>? defaultTableExpirationMs, Input<String>? description, Input<ExternalDatasetReference>? externalDatasetReference, Input<String>? friendlyName, Input<bool>? isCaseInsensitive, Input<Map<String, String>>? labels, Input<String>? location, Input<String>? maxTimeTravelHours, Input<String>? project, Input<String>? storageBillingModel, Input<List<DatasetTagsItem>>? tags})
Creates a new DatasetArgs. access 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; datasetReference Required A reference that identifies the dataset. defaultEncryptionConfiguration Optional. defaultPartitionExpirationMs 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. defaultTableExpirationMs 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 Optional A user-friendly description of the dataset. externalDatasetReference Optional Information about the external metadata storage where the dataset is defined. Filled out when the dataset type is EXTERNAL. friendlyName Optional A descriptive name for the dataset. isCaseInsensitive Optional Indicates if table names are case insensitive in the dataset. labels 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. location The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations. maxTimeTravelHours Optional Number of hours for the max time travel for all tables in the dataset. project Optional. storageBillingModel Optional Storage billing model to be used for all tables in the dataset. Can be set to PHYSICAL. Default is LOGICAL. tags OptionalThe tags associated with this dataset. Tag keys are globally unique.
const
DatasetArgs.fromMap(Map<String, dynamic> map)
factory

Properties

access → Input<List<DatasetAccessItem>>?
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;
final
datasetReference → Input<DatasetReference>?
Required A reference that identifies the dataset.
final
defaultEncryptionConfiguration → Input<EncryptionConfiguration>?
final
defaultPartitionExpirationMs → Input<String>?
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.
final
defaultTableExpirationMs → Input<String>?
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.
final
description → Input<String>?
Optional A user-friendly description of the dataset.
final
externalDatasetReference → Input<ExternalDatasetReference>?
Optional Information about the external metadata storage where the dataset is defined. Filled out when the dataset type is EXTERNAL.
final
friendlyName → Input<String>?
Optional A descriptive name for the dataset.
final
hashCode → int
The hash code for this object.
no setterinherited
isCaseInsensitive → Input<bool>?
Optional Indicates if table names are case insensitive in the dataset.
final
labels → Input<Map<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.
final
location → Input<String>?
The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.
final
maxTimeTravelHours → Input<String>?
Optional Number of hours for the max time travel for all tables in the dataset.
final
project → Input<String>?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
storageBillingModel → Input<String>?
Optional Storage billing model to be used for all tables in the dataset. Can be set to PHYSICAL. Default is LOGICAL.
final
tags → Input<List<DatasetTagsItem>>?
OptionalThe tags associated with this dataset. Tag keys are globally unique.
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