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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DatasetInfo.Builder
A builder forDatasetInfo
objects.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
List<Acl>
getAcl()
Returns the dataset's access control configuration.Long
getCreationTime()
Returns the time when this dataset was created, in milliseconds since the epoch.DatasetId
getDatasetId()
Returns the dataset identity.String
getDefaultCollation()
EncryptionConfiguration
getDefaultEncryptionConfiguration()
Long
getDefaultPartitionExpirationMs()
Long
getDefaultTableLifetime()
Returns the default lifetime of all tables in the dataset, in milliseconds.String
getDescription()
Returns a user-friendly description for the dataset.String
getEtag()
Returns the hash of the dataset resource.ExternalDatasetReference
getExternalDatasetReference()
Returns information about the external metadata storage where the dataset is defined.String
getFriendlyName()
Returns a user-friendly name for the dataset.String
getGeneratedId()
Returns the service-generated id for the dataset.Map<String,String>
getLabels()
Return a map for labels applied to the dataset.Long
getLastModified()
Returns the time when this dataset or any of its tables was last modified, in milliseconds since the epoch.String
getLocation()
Returns the geographic location where the dataset should reside.String
getSelfLink()
Returns an URL that can be used to access the resource again.int
hashCode()
static DatasetInfo.Builder
newBuilder(DatasetId datasetId)
Returns a builder for aDatasetInfo
object given it's identity.static DatasetInfo.Builder
newBuilder(String datasetId)
Returns a builder for aDatasetInfo
object given it's user-defined id.static DatasetInfo.Builder
newBuilder(String projectId, String datasetId)
Returns a builder for the DatasetInfo object given it's user-defined project and dataset ids.static DatasetInfo
of(DatasetId datasetId)
Returns aDatasetInfo
object given it's identity.static DatasetInfo
of(String datasetId)
Returns aDatasetInfo
object given it's user-defined id.DatasetInfo.Builder
toBuilder()
Returns a builder for the dataset object.String
toString()
-
-
-
Method Detail
-
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:
- Access Control
-
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:
- Dataset Location
-
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:
- Labeling Datasets
-
getDefaultEncryptionConfiguration
public EncryptionConfiguration getDefaultEncryptionConfiguration()
-
getDefaultPartitionExpirationMs
public Long getDefaultPartitionExpirationMs()
-
getDefaultCollation
public String getDefaultCollation()
-
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.
-
newBuilder
public static DatasetInfo.Builder newBuilder(DatasetId datasetId)
Returns a builder for aDatasetInfo
object given it's identity.
-
newBuilder
public static DatasetInfo.Builder newBuilder(String datasetId)
Returns a builder for aDatasetInfo
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 aDatasetInfo
object given it's identity.
-
of
public static DatasetInfo of(String datasetId)
Returns aDatasetInfo
object given it's user-defined id.
-
-