Class Dataset.Builder (2.38.1)

public static final class Dataset.Builder extends DatasetInfo.Builder

A builder for Dataset objects.

Inheritance

java.lang.Object > DatasetInfo.Builder > Dataset.Builder

Methods

build()

public Dataset build()

Creates a DatasetInfo object.

Returns
TypeDescription
Dataset
Overrides

setAcl(List<Acl> acl)

public Dataset.Builder setAcl(List<Acl> acl)

Sets the dataset's access control configuration.

Parameter
NameDescription
aclList<Acl>
Returns
TypeDescription
Dataset.Builder
Overrides

setDatasetId(DatasetId datasetId)

public Dataset.Builder setDatasetId(DatasetId datasetId)

Sets the dataset identity.

Parameter
NameDescription
datasetIdDatasetId
Returns
TypeDescription
Dataset.Builder
Overrides

setDefaultCollation(String defaultCollation)

public Dataset.Builder setDefaultCollation(String defaultCollation)

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 --)

Parameter
NameDescription
defaultCollationString
Returns
TypeDescription
Dataset.Builder
Overrides

setDefaultEncryptionConfiguration(EncryptionConfiguration defaultEncryptionConfiguration)

public Dataset.Builder setDefaultEncryptionConfiguration(EncryptionConfiguration defaultEncryptionConfiguration)

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.

Parameter
NameDescription
defaultEncryptionConfigurationEncryptionConfiguration
Returns
TypeDescription
Dataset.Builder
Overrides

setDefaultPartitionExpirationMs(Long defaultPartitionExpirationMs)

public Dataset.Builder setDefaultPartitionExpirationMs(Long defaultPartitionExpirationMs)

[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 be null.

Parameter
NameDescription
defaultPartitionExpirationMsLong
Returns
TypeDescription
Dataset.Builder
Overrides

setDefaultTableLifetime(Long defaultTableLifetime)

public Dataset.Builder setDefaultTableLifetime(Long defaultTableLifetime)

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.

Parameter
NameDescription
defaultTableLifetimeLong
Returns
TypeDescription
Dataset.Builder
Overrides

setDescription(String description)

public Dataset.Builder setDescription(String description)

Sets a user-friendly description for the dataset.

Parameter
NameDescription
descriptionString
Returns
TypeDescription
Dataset.Builder
Overrides

setExternalDatasetReference(ExternalDatasetReference externalDatasetReference)

public Dataset.Builder setExternalDatasetReference(ExternalDatasetReference externalDatasetReference)

Optional. Information about the external metadata storage where the dataset is defined. Filled out when the dataset type is EXTERNAL

Parameter
NameDescription
externalDatasetReferenceExternalDatasetReference
Returns
TypeDescription
Dataset.Builder
Overrides

setFriendlyName(String friendlyName)

public Dataset.Builder setFriendlyName(String friendlyName)

Sets a user-friendly name for the dataset.

Parameter
NameDescription
friendlyNameString
Returns
TypeDescription
Dataset.Builder
Overrides

setLabels(Map<String,String> labels)

public Dataset.Builder setLabels(Map<String,String> labels)
Parameter
NameDescription
labelsMap<String,String>
Returns
TypeDescription
Dataset.Builder
Overrides

setLocation(String location)

public Dataset.Builder setLocation(String location)

Sets the geographic location where the dataset should reside. This property is experimental and might be subject to change or removed.

Parameter
NameDescription
locationString
Returns
TypeDescription
Dataset.Builder
Overrides

setStorageBillingModel(String storageBillingModel)

public Dataset.Builder setStorageBillingModel(String storageBillingModel)

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

Parameter
NameDescription
storageBillingModelString
Returns
TypeDescription
Dataset.Builder
Overrides