DatasetArgs

data class DatasetArgs(val access: Output<List<DatasetAccessItemArgs>>? = null, val datasetReference: Output<DatasetReferenceArgs>? = null, val defaultEncryptionConfiguration: Output<EncryptionConfigurationArgs>? = null, val defaultPartitionExpirationMs: Output<String>? = null, val defaultTableExpirationMs: Output<String>? = null, val description: Output<String>? = null, val friendlyName: Output<String>? = null, val isCaseInsensitive: Output<Boolean>? = null, val labels: Output<Map<String, String>>? = null, val location: Output<String>? = null, val maxTimeTravelHours: Output<String>? = null, val project: Output<String>? = null, val storageBillingModel: Output<String>? = null, val tags: Output<List<DatasetTagsItemArgs>>? = null) : ConvertibleToJava<DatasetArgs>

Creates a new empty dataset. Auto-naming is currently not supported for this resource.

Constructors

Link copied to clipboard
fun DatasetArgs(access: Output<List<DatasetAccessItemArgs>>? = null, datasetReference: Output<DatasetReferenceArgs>? = null, defaultEncryptionConfiguration: Output<EncryptionConfigurationArgs>? = null, defaultPartitionExpirationMs: Output<String>? = null, defaultTableExpirationMs: Output<String>? = null, description: Output<String>? = null, friendlyName: Output<String>? = null, isCaseInsensitive: Output<Boolean>? = null, labels: Output<Map<String, String>>? = null, location: Output<String>? = null, maxTimeTravelHours: Output<String>? = null, project: Output<String>? = null, storageBillingModel: Output<String>? = null, tags: Output<List<DatasetTagsItemArgs>>? = null)

Functions

Link copied to clipboard
open override fun toJava(): DatasetArgs

Properties

Link copied to clipboard
val access: Output<List<DatasetAccessItemArgs>>? = null

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;

Link copied to clipboard

Required A reference that identifies the dataset.

Link copied to clipboard

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.

Link copied to clipboard
val defaultTableExpirationMs: Output<String>? = null

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.

Link copied to clipboard
val description: Output<String>? = null

Optional A user-friendly description of the dataset.

Link copied to clipboard
val friendlyName: Output<String>? = null

Optional A descriptive name for the dataset.

Link copied to clipboard
val isCaseInsensitive: Output<Boolean>? = null

Optional Indicates if table names are case insensitive in the dataset.

Link copied to clipboard
val labels: Output<Map<String, String>>? = null

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.

Link copied to clipboard
val location: Output<String>? = null

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

Link copied to clipboard
val maxTimeTravelHours: Output<String>? = null

Optional Number of hours for the max time travel for all tables in the dataset.

Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val storageBillingModel: Output<String>? = null

Optional Storage billing model to be used for all tables in the dataset. Can be set to PHYSICAL. Default is LOGICAL.

Link copied to clipboard
val tags: Output<List<DatasetTagsItemArgs>>? = null

OptionalThe tags associated with this dataset. Tag keys are globally unique.