com.google.api.services.bigquery.model

Class Dataset

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.bigquery.model.Dataset

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class Dataset
extends com.google.api.client.json.GenericJson

Model definition for Dataset.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the BigQuery API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Dataset.Access Model definition for DatasetAccess.

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Dataset()

Method Summary

Methods

Modifier and Type	Method and Description
Dataset	clone()
java.util.List<Dataset.Access>	getAccess() [Optional] An array of objects that define dataset access for one or more entities.
java.lang.Long	getCreationTime() [Output-only] The time when this dataset was created, in milliseconds since the epoch.
DatasetReference	getDatasetReference() [Required] A reference that identifies the dataset.
java.lang.Long	getDefaultTableExpirationMs() [Optional] The default lifetime of all tables in the dataset, in milliseconds.
java.lang.String	getDescription() [Optional] A user-friendly description of the dataset.
java.lang.String	getEtag() [Output-only] A hash of the resource.
java.lang.String	getFriendlyName() [Optional] A descriptive name for the dataset.
java.lang.String	getId() [Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId.
java.lang.String	getKind() [Output-only] The resource type.
java.util.Map<java.lang.String,java.lang.String>	getLabels() The labels associated with this dataset.
java.lang.Long	getLastModifiedTime() [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
java.lang.String	getLocation() The geographic location where the dataset should reside.
java.lang.String	getSelfLink() [Output-only] A URL that can be used to access the resource again.
Dataset	set(java.lang.String fieldName, java.lang.Object value)
Dataset	setAccess(java.util.List<Dataset.Access> access) [Optional] An array of objects that define dataset access for one or more entities.
Dataset	setCreationTime(java.lang.Long creationTime) [Output-only] The time when this dataset was created, in milliseconds since the epoch.
Dataset	setDatasetReference(DatasetReference datasetReference) [Required] A reference that identifies the dataset.
Dataset	setDefaultTableExpirationMs(java.lang.Long defaultTableExpirationMs) [Optional] The default lifetime of all tables in the dataset, in milliseconds.
Dataset	setDescription(java.lang.String description) [Optional] A user-friendly description of the dataset.
Dataset	setEtag(java.lang.String etag) [Output-only] A hash of the resource.
Dataset	setFriendlyName(java.lang.String friendlyName) [Optional] A descriptive name for the dataset.
Dataset	setId(java.lang.String id) [Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId.
Dataset	setKind(java.lang.String kind) [Output-only] The resource type.
Dataset	setLabels(java.util.Map<java.lang.String,java.lang.String> labels) The labels associated with this dataset.
Dataset	setLastModifiedTime(java.lang.Long lastModifiedTime) [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
Dataset	setLocation(java.lang.String location) The geographic location where the dataset should reside.
Dataset	setSelfLink(java.lang.String selfLink) [Output-only] A URL that can be used to access the resource again.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Dataset

public Dataset()

Method Detail

getAccess

public java.util.List<Dataset.Access> getAccess()

[Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;

Returns:

value or null for none

setAccess

public Dataset setAccess(java.util.List<Dataset.Access> access)

[Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;

Parameters:

access - access or null for none

getCreationTime

public java.lang.Long getCreationTime()

[Output-only] The time when this dataset was created, in milliseconds since the epoch.

Returns:

value or null for none

setCreationTime

public Dataset setCreationTime(java.lang.Long creationTime)

[Output-only] The time when this dataset was created, in milliseconds since the epoch.

Parameters:

creationTime - creationTime or null for none

getDatasetReference

public DatasetReference getDatasetReference()

[Required] A reference that identifies the dataset.

Returns:

value or null for none

setDatasetReference

public Dataset setDatasetReference(DatasetReference datasetReference)

[Required] A reference that identifies the dataset.

Parameters:

datasetReference - datasetReference or null for none

getDefaultTableExpirationMs

public java.lang.Long getDefaultTableExpirationMs()

[Optional] 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.

Returns:

value or null for none

setDefaultTableExpirationMs

public Dataset setDefaultTableExpirationMs(java.lang.Long defaultTableExpirationMs)

[Optional] 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.

Parameters:

defaultTableExpirationMs - defaultTableExpirationMs or null for none

getDescription

public java.lang.String getDescription()

[Optional] A user-friendly description of the dataset.

Returns:

value or null for none

setDescription

public Dataset setDescription(java.lang.String description)

[Optional] A user-friendly description of the dataset.

Parameters:

description - description or null for none

getEtag

public java.lang.String getEtag()

[Output-only] A hash of the resource.

Returns:

value or null for none

setEtag

public Dataset setEtag(java.lang.String etag)

[Output-only] A hash of the resource.

Parameters:

etag - etag or null for none

getFriendlyName

public java.lang.String getFriendlyName()

[Optional] A descriptive name for the dataset.

Returns:

value or null for none

setFriendlyName

public Dataset setFriendlyName(java.lang.String friendlyName)

[Optional] A descriptive name for the dataset.

Parameters:

friendlyName - friendlyName or null for none

getId

public java.lang.String getId()

[Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.

Returns:

value or null for none

setId

public Dataset setId(java.lang.String id)

[Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.

Parameters:

id - id or null for none

getKind

public java.lang.String getKind()

[Output-only] The resource type.

Returns:

value or null for none

setKind

public Dataset setKind(java.lang.String kind)

[Output-only] The resource type.

Parameters:

kind - kind or null for none

getLabels

public java.util.Map<java.lang.String,java.lang.String> getLabels()

The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.

Returns:

value or null for none

setLabels

public Dataset setLabels(java.util.Map<java.lang.String,java.lang.String> labels)

The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.

Parameters:

labels - labels or null for none

getLastModifiedTime

public java.lang.Long getLastModifiedTime()

[Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.

Returns:

value or null for none

setLastModifiedTime

public Dataset setLastModifiedTime(java.lang.Long lastModifiedTime)

[Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.

Parameters:

lastModifiedTime - lastModifiedTime or null for none

getLocation

public java.lang.String getLocation()

The geographic location where the dataset should reside. The default value is US.

Returns:

value or null for none

setLocation

public Dataset setLocation(java.lang.String location)

The geographic location where the dataset should reside. The default value is US.

Parameters:

location - location or null for none

getSelfLink

public java.lang.String getSelfLink()

[Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.

Returns:

value or null for none

setSelfLink

public Dataset setSelfLink(java.lang.String selfLink)

[Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.

Parameters:

selfLink - selfLink or null for none

set

public Dataset set(java.lang.String fieldName,
          java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Dataset clone()

Overrides:

clone in class com.google.api.client.json.GenericJson