Package com.google.cloud.bigquery
Class Dataset.Builder
java.lang.Object
com.google.cloud.bigquery.DatasetInfo.Builder
com.google.cloud.bigquery.Dataset.Builder
- Enclosing class:
- Dataset
A builder for
Dataset
objects.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Creates aDatasetInfo
object.Sets the dataset's access control configuration.setDatasetId
(DatasetId datasetId) Sets the dataset identity.setDefaultCollation
(String defaultCollation) Optional.setDefaultEncryptionConfiguration
(EncryptionConfiguration defaultEncryptionConfiguration) The default encryption key for all tables in the dataset.setDefaultPartitionExpirationMs
(Long defaultPartitionExpirationMs) [Optional] The default partition expiration time for all partitioned tables in the dataset, in milliseconds.setDefaultTableLifetime
(Long defaultTableLifetime) Sets the default lifetime of all tables in the dataset, in milliseconds.setDescription
(String description) Sets a user-friendly description for the dataset.setExternalDatasetReference
(ExternalDatasetReference externalDatasetReference) Optional.setFriendlyName
(String friendlyName) Sets a user-friendly name for the dataset.setLocation
(String location) Sets the geographic location where the dataset should reside.setStorageBillingModel
(String storageBillingModel) Optional.
-
Method Details
-
setDatasetId
Description copied from class:DatasetInfo.Builder
Sets the dataset identity.- Specified by:
setDatasetId
in classDatasetInfo.Builder
-
setAcl
Description copied from class:DatasetInfo.Builder
Sets the dataset's access control configuration.- Specified by:
setAcl
in classDatasetInfo.Builder
- See Also:
-
setDefaultTableLifetime
Description copied from class:DatasetInfo.Builder
Sets 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. This property is experimental and might be subject to change or removed.- Specified by:
setDefaultTableLifetime
in classDatasetInfo.Builder
-
setDescription
Description copied from class:DatasetInfo.Builder
Sets a user-friendly description for the dataset.- Specified by:
setDescription
in classDatasetInfo.Builder
-
setFriendlyName
Description copied from class:DatasetInfo.Builder
Sets a user-friendly name for the dataset.- Specified by:
setFriendlyName
in classDatasetInfo.Builder
-
setLocation
Description copied from class:DatasetInfo.Builder
Sets the geographic location where the dataset should reside. This property is experimental and might be subject to change or removed.- Specified by:
setLocation
in classDatasetInfo.Builder
- See Also:
-
setLabels
- Specified by:
setLabels
in classDatasetInfo.Builder
-
setDefaultEncryptionConfiguration
public Dataset.Builder setDefaultEncryptionConfiguration(EncryptionConfiguration defaultEncryptionConfiguration) Description copied from class:DatasetInfo.Builder
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.- Specified by:
setDefaultEncryptionConfiguration
in classDatasetInfo.Builder
-
setDefaultPartitionExpirationMs
Description copied from class:DatasetInfo.Builder
[Optional] The default partition expiration time for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will has an expirationMs property in the timePartitioning settings set to this value. Changing the value 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. The value may benull
.- Specified by:
setDefaultPartitionExpirationMs
in classDatasetInfo.Builder
-
setDefaultCollation
Description copied from class:DatasetInfo.Builder
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. (-- A wrapper is used here because it is possible to set the value to the empty string. --) (-- api-linter: standard-fields=disabled --)
- Specified by:
setDefaultCollation
in classDatasetInfo.Builder
-
setExternalDatasetReference
public Dataset.Builder setExternalDatasetReference(ExternalDatasetReference externalDatasetReference) Description copied from class:DatasetInfo.Builder
Optional. Information about the external metadata storage where the dataset is defined. Filled out when the dataset type is EXTERNAL- Specified by:
setExternalDatasetReference
in classDatasetInfo.Builder
-
setStorageBillingModel
Description copied from class:DatasetInfo.Builder
Optional. Storage billing model to be used for all tables in the dataset. Can be set to PHYSICAL. Default is LOGICAL.- Specified by:
setStorageBillingModel
in classDatasetInfo.Builder
-
build
Description copied from class:DatasetInfo.Builder
Creates aDatasetInfo
object.- Specified by:
build
in classDatasetInfo.Builder
-