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
public static final class Dataset.Builder extends DatasetInfo.Builder
A builder for Dataset objects.

  • Method Details

    • setDatasetId

      public Dataset.Builder setDatasetId(DatasetId datasetId)
      Description copied from class: DatasetInfo.Builder
      Sets the dataset identity.
      Specified by:
      setDatasetId in class DatasetInfo.Builder

    • setAcl

      public Dataset.Builder setAcl(List<Acl> acl)
      Description copied from class: DatasetInfo.Builder
      Sets the dataset's access control configuration.
      Specified by:
      setAcl in class DatasetInfo.Builder
      See Also:

    • setDefaultTableLifetime

      public Dataset.Builder setDefaultTableLifetime(Long defaultTableLifetime)
      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 class DatasetInfo.Builder

    • setDescription

      public Dataset.Builder setDescription(String description)
      Description copied from class: DatasetInfo.Builder
      Sets a user-friendly description for the dataset.
      Specified by:
      setDescription in class DatasetInfo.Builder

    • setFriendlyName

      public Dataset.Builder setFriendlyName(String friendlyName)
      Description copied from class: DatasetInfo.Builder
      Sets a user-friendly name for the dataset.
      Specified by:
      setFriendlyName in class DatasetInfo.Builder

    • setLocation

      public Dataset.Builder setLocation(String location)
      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 class DatasetInfo.Builder
      See Also:

    • setLabels

      public Dataset.Builder setLabels(Map<String,String> labels)
      Specified by:
      setLabels in class DatasetInfo.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 class DatasetInfo.Builder

    • setDefaultPartitionExpirationMs

      public Dataset.Builder setDefaultPartitionExpirationMs(Long defaultPartitionExpirationMs)
      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 be null.
      Specified by:
      setDefaultPartitionExpirationMs in class DatasetInfo.Builder

    • setDefaultCollation

      public Dataset.Builder setDefaultCollation(String defaultCollation)
      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 class DatasetInfo.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 class DatasetInfo.Builder

    • setStorageBillingModel

      public Dataset.Builder setStorageBillingModel(String storageBillingModel)
      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 class DatasetInfo.Builder

    • setMaxTimeTravelHours

      public Dataset.Builder setMaxTimeTravelHours(Long maxTimeTravelHours)
      Description copied from class: DatasetInfo.Builder
      Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set. The value may be null.
      Specified by:
      setMaxTimeTravelHours in class DatasetInfo.Builder

    • setResourceTags

      public Dataset.Builder setResourceTags(Map<String,String> resourceTags)
      Description copied from class: DatasetInfo.Builder
      Optional. The tags attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production".
      Specified by:
      setResourceTags in class DatasetInfo.Builder
      Parameters:
      resourceTags - resourceTags or null for none
      See Also:

    • build

      public Dataset build()
      Description copied from class: DatasetInfo.Builder
      Creates a DatasetInfo object.
      Specified by:
      build in class DatasetInfo.Builder