Class DatasetInfo.Builder (2.33.2)

public abstract static class DatasetInfo.Builder

A builder for DatasetInfo objects.

Inheritance

java.lang.Object > DatasetInfo.Builder

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

Builder()

public Builder()

Methods

build()

public abstract DatasetInfo build()

Creates a DatasetInfo object.

Returns
Type	Description
`DatasetInfo`

setAcl(List<Acl> acl)

public abstract DatasetInfo.Builder setAcl(List<Acl> acl)

Sets the dataset's access control configuration. See Also: Access Control

Parameter
Name	Description
`acl`	`List<Acl>`

Returns
Type	Description
`DatasetInfo.Builder`

setDatasetId(DatasetId datasetId)

public abstract DatasetInfo.Builder setDatasetId(DatasetId datasetId)

Sets the dataset identity.

Parameter
Name	Description
`datasetId`	`DatasetId`

Returns
Type	Description
`DatasetInfo.Builder`

setDefaultCollation(String defaultCollation)

public abstract DatasetInfo.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
Name	Description
`defaultCollation`	`String`

Returns
Type	Description
`DatasetInfo.Builder`

setDefaultEncryptionConfiguration(EncryptionConfiguration defaultEncryptionConfiguration)

public abstract DatasetInfo.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
Name	Description
`defaultEncryptionConfiguration`	`EncryptionConfiguration`

Returns
Type	Description
`DatasetInfo.Builder`

setDefaultPartitionExpirationMs(Long defaultPartitionExpirationMs)

public abstract DatasetInfo.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
Name	Description
`defaultPartitionExpirationMs`	`Long`

Returns
Type	Description
`DatasetInfo.Builder`

setDefaultTableLifetime(Long defaultTableLifetime)

public abstract DatasetInfo.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
Name	Description
`defaultTableLifetime`	`Long`

Returns
Type	Description
`DatasetInfo.Builder`

setDescription(String description)

public abstract DatasetInfo.Builder setDescription(String description)

Sets a user-friendly description for the dataset.

Parameter
Name	Description
`description`	`String`

Returns
Type	Description
`DatasetInfo.Builder`

setExternalDatasetReference(ExternalDatasetReference externalDatasetReference)

public abstract DatasetInfo.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
Name	Description
`externalDatasetReference`	`ExternalDatasetReference`

Returns
Type	Description
`DatasetInfo.Builder`

setFriendlyName(String friendlyName)

public abstract DatasetInfo.Builder setFriendlyName(String friendlyName)

Sets a user-friendly name for the dataset.

Parameter
Name	Description
`friendlyName`	`String`

Returns
Type	Description
`DatasetInfo.Builder`

setLabels(Map<String,String> labels)

public abstract DatasetInfo.Builder setLabels(Map<String,String> labels)

Parameter
Name	Description
`labels`	`Map<String,String>`

Returns
Type	Description
`DatasetInfo.Builder`

setLocation(String location)

public abstract DatasetInfo.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. See Also: Dataset Location

Parameter
Name	Description
`location`	`String`

Returns
Type	Description
`DatasetInfo.Builder`