Package com.google.cloud.bigquery

Class DatasetInfo

java.lang.Object
com.google.cloud.bigquery.DatasetInfo
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
Dataset
public class DatasetInfo extends Object implements Serializable
Google BigQuery Dataset information. A dataset is a grouping mechanism that holds zero or more tables. Datasets are the lowest level unit of access control; you cannot control access at the table level.
See Also:

  • Method Details

    • getDatasetId

      public DatasetId getDatasetId()
      Returns the dataset identity.

    • getAcl

      public List<Acl> getAcl()
      Returns the dataset's access control configuration.

      Update the ACLs for a dataset. 

      
 Dataset dataset = bigquery.getDataset(DatasetId.of("my_dataset"));
 List<Acl> beforeAcls = dataset.getAcl();

 // Make a copy of the ACLs so that they can be modified.
 ArrayList<Acl> acls = new ArrayList<>(beforeAcls);
 acls.add(Acl.of(new Acl.User("sample.bigquery.dev@gmail.com"), Acl.Role.READER));
 Dataset.Builder builder = dataset.toBuilder();
 builder.setAcl(acls);

 bigquery.update(builder.build());  // API request.
      See Also:

    • getCreationTime

      public Long getCreationTime()
      Returns the time when this dataset was created, in milliseconds since the epoch.

    • getDefaultTableLifetime

      public Long getDefaultTableLifetime()
      Returns the default lifetime of all tables in the dataset, in milliseconds. 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.

      Update the default table expiration time for a dataset. 

      
 Dataset dataset = bigquery.getDataset(DatasetId.of("my_dataset"));
 Long beforeExpiration = dataset.getDefaultTableLifetime();

 Long oneDayMilliseconds = 24 * 60 * 60 * 1000L;
 Dataset.Builder builder = dataset.toBuilder();
 builder.setDefaultTableLifetime(oneDayMilliseconds);
 bigquery.update(builder.build());  // API request.

    • getDescription

      public String getDescription()
      Returns a user-friendly description for the dataset.

    • getEtag

      public String getEtag()
      Returns the hash of the dataset resource.

    • getFriendlyName

      public String getFriendlyName()
      Returns a user-friendly name for the dataset.

    • getGeneratedId

      public String getGeneratedId()
      Returns the service-generated id for the dataset.

    • getLastModified

      public Long getLastModified()
      Returns the time when this dataset or any of its tables was last modified, in milliseconds since the epoch.

    • getLocation

      public String getLocation()
      Returns the geographic location where the dataset should reside.
      See Also:

    • getSelfLink

      public String getSelfLink()
      Returns an URL that can be used to access the resource again. The returned URL can be used for get or update requests.

    • getLabels

      public Map<String,String> getLabels()
      Return a map for labels applied to the dataset.
      See Also:

    • getDefaultEncryptionConfiguration

      public EncryptionConfiguration getDefaultEncryptionConfiguration()

    • getDefaultPartitionExpirationMs

      public Long getDefaultPartitionExpirationMs()

    • getDefaultCollation

      public String getDefaultCollation()

    • getStorageBillingModel

      public String getStorageBillingModel()

    • getMaxTimeTravelHours

      public Long getMaxTimeTravelHours()
      Returns the number of hours that deleted or updated data will be available to be queried for all tables in the dataset.

    • getResourceTags

      public Map<String,String> getResourceTags()
      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".
      Returns:
      value or null for none
      See Also:

    • getExternalDatasetReference

      public ExternalDatasetReference getExternalDatasetReference()
      Returns information about the external metadata storage where the dataset is defined. Filled out when the dataset type is EXTERNAL.

    • toBuilder

      public DatasetInfo.Builder toBuilder()
      Returns a builder for the dataset object.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • newBuilder

      public static DatasetInfo.Builder newBuilder(DatasetId datasetId)
      Returns a builder for a DatasetInfo object given it's identity.

    • newBuilder

      public static DatasetInfo.Builder newBuilder(String datasetId)
      Returns a builder for a DatasetInfo object given it's user-defined id.

    • newBuilder

      public static DatasetInfo.Builder newBuilder(String projectId, String datasetId)
      Returns a builder for the DatasetInfo object given it's user-defined project and dataset ids.

    • of

      public static DatasetInfo of(DatasetId datasetId)
      Returns a DatasetInfo object given it's identity.

    • of

      public static DatasetInfo of(String datasetId)
      Returns a DatasetInfo object given it's user-defined id.

    • getOtelAttributes

      protected io.opentelemetry.api.common.Attributes getOtelAttributes()