com.google.api.services.bigquery.model

Class Table

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.Table

All Implemented Interfaces:

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

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

Model definition for Table.

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/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
Table()

Method Summary

Methods

Modifier and Type	Method and Description
Table	clone()
Clustering	getClustering() [Experimental] Clustering specification for the table.
java.lang.Long	getCreationTime() [Output-only] The time when this table was created, in milliseconds since the epoch.
java.lang.String	getDescription() [Optional] A user-friendly description of this table.
EncryptionConfiguration	getEncryptionConfiguration() Custom encryption configuration (e.g., Cloud KMS keys).
java.lang.String	getEtag() [Output-only] A hash of this resource.
java.lang.Long	getExpirationTime() [Optional] The time when this table expires, in milliseconds since the epoch.
ExternalDataConfiguration	getExternalDataConfiguration() [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery.
java.lang.String	getFriendlyName() [Optional] A descriptive name for this table.
java.lang.String	getId() [Output-only] An opaque ID uniquely identifying the table.
java.lang.String	getKind() [Output-only] The type of the resource.
java.util.Map<java.lang.String,java.lang.String>	getLabels() The labels associated with this table.
java.math.BigInteger	getLastModifiedTime() [Output-only] The time when this table was last modified, in milliseconds since the epoch.
java.lang.String	getLocation() [Output-only] The geographic location where the table resides.
java.lang.Long	getNumBytes() [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.
java.lang.Long	getNumLongTermBytes() [Output-only] The number of bytes in the table that are considered "long-term storage".
java.math.BigInteger	getNumRows() [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.
TableSchema	getSchema() [Optional] Describes the schema of this table.
java.lang.String	getSelfLink() [Output-only] A URL that can be used to access this resource again.
Streamingbuffer	getStreamingBuffer() [Output-only] Contains information regarding this table's streaming buffer, if one is present.
TableReference	getTableReference() [Required] Reference describing the ID of this table.
TimePartitioning	getTimePartitioning() Time-based partitioning specification for this table.
java.lang.String	getType() [Output-only] Describes the table type.
ViewDefinition	getView() [Optional] The view definition.
Table	set(java.lang.String fieldName, java.lang.Object value)
Table	setClustering(Clustering clustering) [Experimental] Clustering specification for the table.
Table	setCreationTime(java.lang.Long creationTime) [Output-only] The time when this table was created, in milliseconds since the epoch.
Table	setDescription(java.lang.String description) [Optional] A user-friendly description of this table.
Table	setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration) Custom encryption configuration (e.g., Cloud KMS keys).
Table	setEtag(java.lang.String etag) [Output-only] A hash of this resource.
Table	setExpirationTime(java.lang.Long expirationTime) [Optional] The time when this table expires, in milliseconds since the epoch.
Table	setExternalDataConfiguration(ExternalDataConfiguration externalDataConfiguration) [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery.
Table	setFriendlyName(java.lang.String friendlyName) [Optional] A descriptive name for this table.
Table	setId(java.lang.String id) [Output-only] An opaque ID uniquely identifying the table.
Table	setKind(java.lang.String kind) [Output-only] The type of the resource.
Table	setLabels(java.util.Map<java.lang.String,java.lang.String> labels) The labels associated with this table.
Table	setLastModifiedTime(java.math.BigInteger lastModifiedTime) [Output-only] The time when this table was last modified, in milliseconds since the epoch.
Table	setLocation(java.lang.String location) [Output-only] The geographic location where the table resides.
Table	setNumBytes(java.lang.Long numBytes) [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.
Table	setNumLongTermBytes(java.lang.Long numLongTermBytes) [Output-only] The number of bytes in the table that are considered "long-term storage".
Table	setNumRows(java.math.BigInteger numRows) [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.
Table	setSchema(TableSchema schema) [Optional] Describes the schema of this table.
Table	setSelfLink(java.lang.String selfLink) [Output-only] A URL that can be used to access this resource again.
Table	setStreamingBuffer(Streamingbuffer streamingBuffer) [Output-only] Contains information regarding this table's streaming buffer, if one is present.
Table	setTableReference(TableReference tableReference) [Required] Reference describing the ID of this table.
Table	setTimePartitioning(TimePartitioning timePartitioning) Time-based partitioning specification for this table.
Table	setType(java.lang.String type) [Output-only] Describes the table type.
Table	setView(ViewDefinition view) [Optional] The view definition.

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

Table

public Table()

Method Detail

getClustering

public Clustering getClustering()

[Experimental] Clustering specification for the table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.

Returns:

value or null for none

setClustering

public Table setClustering(Clustering clustering)

[Experimental] Clustering specification for the table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.

Parameters:

clustering - clustering or null for none

getCreationTime

public java.lang.Long getCreationTime()

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

Returns:

value or null for none

setCreationTime

public Table setCreationTime(java.lang.Long creationTime)

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

Parameters:

creationTime - creationTime or null for none

getDescription

public java.lang.String getDescription()

[Optional] A user-friendly description of this table.

Returns:

value or null for none

setDescription

public Table setDescription(java.lang.String description)

[Optional] A user-friendly description of this table.

Parameters:

description - description or null for none

getEncryptionConfiguration

public EncryptionConfiguration getEncryptionConfiguration()

Custom encryption configuration (e.g., Cloud KMS keys).

Returns:

value or null for none

setEncryptionConfiguration

public Table setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

Custom encryption configuration (e.g., Cloud KMS keys).

Parameters:

encryptionConfiguration - encryptionConfiguration or null for none

getEtag

public java.lang.String getEtag()

[Output-only] A hash of this resource.

Returns:

value or null for none

setEtag

public Table setEtag(java.lang.String etag)

[Output-only] A hash of this resource.

Parameters:

etag - etag or null for none

getExpirationTime

public java.lang.Long getExpirationTime()

[Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.

Returns:

value or null for none

setExpirationTime

public Table setExpirationTime(java.lang.Long expirationTime)

[Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.

Parameters:

expirationTime - expirationTime or null for none

getExternalDataConfiguration

public ExternalDataConfiguration getExternalDataConfiguration()

[Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

Returns:

value or null for none

setExternalDataConfiguration

public Table setExternalDataConfiguration(ExternalDataConfiguration externalDataConfiguration)

[Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

Parameters:

externalDataConfiguration - externalDataConfiguration or null for none

getFriendlyName

public java.lang.String getFriendlyName()

[Optional] A descriptive name for this table.

Returns:

value or null for none

setFriendlyName

public Table setFriendlyName(java.lang.String friendlyName)

[Optional] A descriptive name for this table.

Parameters:

friendlyName - friendlyName or null for none

getId

public java.lang.String getId()

[Output-only] An opaque ID uniquely identifying the table.

Returns:

value or null for none

setId

public Table setId(java.lang.String id)

[Output-only] An opaque ID uniquely identifying the table.

Parameters:

id - id or null for none

getKind

public java.lang.String getKind()

[Output-only] The type of the resource.

Returns:

value or null for none

setKind

public Table setKind(java.lang.String kind)

[Output-only] The type of the resource.

Parameters:

kind - kind or null for none

getLabels

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

The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.

Returns:

value or null for none

setLabels

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

The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.

Parameters:

labels - labels or null for none

getLastModifiedTime

public java.math.BigInteger getLastModifiedTime()

[Output-only] The time when this table was last modified, in milliseconds since the epoch.

Returns:

value or null for none

setLastModifiedTime

public Table setLastModifiedTime(java.math.BigInteger lastModifiedTime)

[Output-only] The time when this table was last modified, in milliseconds since the epoch.

Parameters:

lastModifiedTime - lastModifiedTime or null for none

getLocation

public java.lang.String getLocation()

[Output-only] The geographic location where the table resides. This value is inherited from the dataset.

Returns:

value or null for none

setLocation

public Table setLocation(java.lang.String location)

[Output-only] The geographic location where the table resides. This value is inherited from the dataset.

Parameters:

location - location or null for none

getNumBytes

public java.lang.Long getNumBytes()

[Output-only] The size of this table in bytes, excluding any data in the streaming buffer.

Returns:

value or null for none

setNumBytes

public Table setNumBytes(java.lang.Long numBytes)

[Output-only] The size of this table in bytes, excluding any data in the streaming buffer.

Parameters:

numBytes - numBytes or null for none

getNumLongTermBytes

public java.lang.Long getNumLongTermBytes()

[Output-only] The number of bytes in the table that are considered "long-term storage".

Returns:

value or null for none

setNumLongTermBytes

public Table setNumLongTermBytes(java.lang.Long numLongTermBytes)

[Output-only] The number of bytes in the table that are considered "long-term storage".

Parameters:

numLongTermBytes - numLongTermBytes or null for none

getNumRows

public java.math.BigInteger getNumRows()

[Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.

Returns:

value or null for none

setNumRows

public Table setNumRows(java.math.BigInteger numRows)

[Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.

Parameters:

numRows - numRows or null for none

getSchema

public TableSchema getSchema()

[Optional] Describes the schema of this table.

Returns:

value or null for none

setSchema

public Table setSchema(TableSchema schema)

[Optional] Describes the schema of this table.

Parameters:

schema - schema or null for none

getSelfLink

public java.lang.String getSelfLink()

[Output-only] A URL that can be used to access this resource again.

Returns:

value or null for none

setSelfLink

public Table setSelfLink(java.lang.String selfLink)

[Output-only] A URL that can be used to access this resource again.

Parameters:

selfLink - selfLink or null for none

getStreamingBuffer

public Streamingbuffer getStreamingBuffer()

[Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

Returns:

value or null for none

setStreamingBuffer

public Table setStreamingBuffer(Streamingbuffer streamingBuffer)

[Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

Parameters:

streamingBuffer - streamingBuffer or null for none

getTableReference

public TableReference getTableReference()

[Required] Reference describing the ID of this table.

Returns:

value or null for none

setTableReference

public Table setTableReference(TableReference tableReference)

[Required] Reference describing the ID of this table.

Parameters:

tableReference - tableReference or null for none

getTimePartitioning

public TimePartitioning getTimePartitioning()

Time-based partitioning specification for this table.

Returns:

value or null for none

setTimePartitioning

public Table setTimePartitioning(TimePartitioning timePartitioning)

Time-based partitioning specification for this table.

Parameters:

timePartitioning - timePartitioning or null for none

getType

public java.lang.String getType()

[Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.

Returns:

value or null for none

setType

public Table setType(java.lang.String type)

[Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.

Parameters:

type - type or null for none

getView

public ViewDefinition getView()

[Optional] The view definition.

Returns:

value or null for none

setView

public Table setView(ViewDefinition view)

[Optional] The view definition.

Parameters:

view - view or null for none

set

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

Overrides:

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

clone

public Table clone()

Overrides:

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