• Home
• com.google.apis
• google-api-services-bigquery
• v2-rev20240727-2.0.0
• source code
• Table.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.bigquery.model.Table.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.bigquery.model
Class Table



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.bigquery.model.Table













All Implemented Interfaces:
Cloneable, Map<String,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
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


Table() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Table
clone() 


BigLakeConfiguration
getBiglakeConfiguration()
Optional.



CloneDefinition
getCloneDefinition()
Output only.



Clustering
getClustering()
Clustering specification for the table.



Long
getCreationTime()
Output only.



String
getDefaultCollation()
Optional.



String
getDefaultRoundingMode()
Optional.



String
getDescription()
Optional.



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



String
getEtag()
Output only.



Long
getExpirationTime()
Optional.



ExternalCatalogTableOptions
getExternalCatalogTableOptions()
Optional.



ExternalDataConfiguration
getExternalDataConfiguration()
Optional.



String
getFriendlyName()
Optional.



String
getId()
Output only.



String
getKind()
The type of resource ID.



Map<String,String>
getLabels()
The labels associated with this table.



BigInteger
getLastModifiedTime()
Output only.



String
getLocation()
Output only.



MaterializedViewDefinition
getMaterializedView()
Optional.



MaterializedViewStatus
getMaterializedViewStatus()
Output only.



String
getMaxStaleness()
Optional.



ModelDefinition
getModel()
Deprecated.



Long
getNumActiveLogicalBytes()
Output only.



Long
getNumActivePhysicalBytes()
Output only.



Long
getNumBytes()
Output only.



Long
getNumCurrentPhysicalBytes()
Output only.



Long
getNumLongTermBytes()
Output only.



Long
getNumLongTermLogicalBytes()
Output only.



Long
getNumLongTermPhysicalBytes()
Output only.



Long
getNumPartitions()
Output only.



Long
getNumPhysicalBytes()
Output only.



BigInteger
getNumRows()
Output only.



Long
getNumTimeTravelPhysicalBytes()
Output only.



Long
getNumTotalLogicalBytes()
Output only.



Long
getNumTotalPhysicalBytes()
Output only.



PartitioningDefinition
getPartitionDefinition()
Optional.



RangePartitioning
getRangePartitioning()
If specified, configures range partitioning for this table.



List<TableReference>
getReplicas()
Optional.



Boolean
getRequirePartitionFilter()
Optional.



Map<String,String>
getResourceTags()
[Optional] The tags associated with this table.



RestrictionConfig
getRestrictions()
Optional.



TableSchema
getSchema()
Optional.



String
getSelfLink()
Output only.



SnapshotDefinition
getSnapshotDefinition()
Output only.



Streamingbuffer
getStreamingBuffer()
Output only.



TableConstraints
getTableConstraints()
Optional.



TableReference
getTableReference()
Required.



TableReplicationInfo
getTableReplicationInfo()
Optional.



TimePartitioning
getTimePartitioning()
If specified, configures time-based partitioning for this table.



String
getType()
Output only.



ViewDefinition
getView()
Optional.



boolean
isRequirePartitionFilter()
Convenience method that returns only Boolean.TRUE or Boolean.FALSE.



Table
set(String fieldName,
   Object value) 


Table
setBiglakeConfiguration(BigLakeConfiguration biglakeConfiguration)
Optional.



Table
setCloneDefinition(CloneDefinition cloneDefinition)
Output only.



Table
setClustering(Clustering clustering)
Clustering specification for the table.



Table
setCreationTime(Long creationTime)
Output only.



Table
setDefaultCollation(String defaultCollation)
Optional.



Table
setDefaultRoundingMode(String defaultRoundingMode)
Optional.



Table
setDescription(String description)
Optional.



Table
setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
Custom encryption configuration (e.g., Cloud KMS keys).



Table
setEtag(String etag)
Output only.



Table
setExpirationTime(Long expirationTime)
Optional.



Table
setExternalCatalogTableOptions(ExternalCatalogTableOptions externalCatalogTableOptions)
Optional.



Table
setExternalDataConfiguration(ExternalDataConfiguration externalDataConfiguration)
Optional.



Table
setFriendlyName(String friendlyName)
Optional.



Table
setId(String id)
Output only.



Table
setKind(String kind)
The type of resource ID.



Table
setLabels(Map<String,String> labels)
The labels associated with this table.



Table
setLastModifiedTime(BigInteger lastModifiedTime)
Output only.



Table
setLocation(String location)
Output only.



Table
setMaterializedView(MaterializedViewDefinition materializedView)
Optional.



Table
setMaterializedViewStatus(MaterializedViewStatus materializedViewStatus)
Output only.



Table
setMaxStaleness(String maxStaleness)
Optional.



Table
setModel(ModelDefinition model)
Deprecated.



Table
setNumActiveLogicalBytes(Long numActiveLogicalBytes)
Output only.



Table
setNumActivePhysicalBytes(Long numActivePhysicalBytes)
Output only.



Table
setNumBytes(Long numBytes)
Output only.



Table
setNumCurrentPhysicalBytes(Long numCurrentPhysicalBytes)
Output only.



Table
setNumLongTermBytes(Long numLongTermBytes)
Output only.



Table
setNumLongTermLogicalBytes(Long numLongTermLogicalBytes)
Output only.



Table
setNumLongTermPhysicalBytes(Long numLongTermPhysicalBytes)
Output only.



Table
setNumPartitions(Long numPartitions)
Output only.



Table
setNumPhysicalBytes(Long numPhysicalBytes)
Output only.



Table
setNumRows(BigInteger numRows)
Output only.



Table
setNumTimeTravelPhysicalBytes(Long numTimeTravelPhysicalBytes)
Output only.



Table
setNumTotalLogicalBytes(Long numTotalLogicalBytes)
Output only.



Table
setNumTotalPhysicalBytes(Long numTotalPhysicalBytes)
Output only.



Table
setPartitionDefinition(PartitioningDefinition partitionDefinition)
Optional.



Table
setRangePartitioning(RangePartitioning rangePartitioning)
If specified, configures range partitioning for this table.



Table
setReplicas(List<TableReference> replicas)
Optional.



Table
setRequirePartitionFilter(Boolean requirePartitionFilter)
Optional.



Table
setResourceTags(Map<String,String> resourceTags)
[Optional] The tags associated with this table.



Table
setRestrictions(RestrictionConfig restrictions)
Optional.



Table
setSchema(TableSchema schema)
Optional.



Table
setSelfLink(String selfLink)
Output only.



Table
setSnapshotDefinition(SnapshotDefinition snapshotDefinition)
Output only.



Table
setStreamingBuffer(Streamingbuffer streamingBuffer)
Output only.



Table
setTableConstraints(TableConstraints tableConstraints)
Optional.



Table
setTableReference(TableReference tableReference)
Required.



Table
setTableReplicationInfo(TableReplicationInfo tableReplicationInfo)
Optional.



Table
setTimePartitioning(TimePartitioning timePartitioning)
If specified, configures time-based partitioning for this table.



Table
setType(String type)
Output only.



Table
setView(ViewDefinition view)
Optional.







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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





Table
public Table()









Method Detail





getBiglakeConfiguration
public BigLakeConfiguration getBiglakeConfiguration()
Optional. Specifies the configuration of a BigLake managed table.

Returns:
value or null for none








setBiglakeConfiguration
public Table setBiglakeConfiguration(BigLakeConfiguration biglakeConfiguration)
Optional. Specifies the configuration of a BigLake managed table.

Parameters:
biglakeConfiguration - biglakeConfiguration or null for none








getCloneDefinition
public CloneDefinition getCloneDefinition()
Output only. Contains information about the clone. This value is set via the clone operation.

Returns:
value or null for none








setCloneDefinition
public Table setCloneDefinition(CloneDefinition cloneDefinition)
Output only. Contains information about the clone. This value is set via the clone operation.

Parameters:
cloneDefinition - cloneDefinition or null for none








getClustering
public Clustering getClustering()
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)
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 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(Long creationTime)
Output only. The time when this table was created, in milliseconds since the epoch.

Parameters:
creationTime - creationTime or null for none








getDefaultCollation
public String getDefaultCollation()
Optional. Defines the default collation specification of new STRING fields in the table. During
 table creation or update, if a STRING field is added to this table without explicit collation
 specified, then the table inherits the table default collation. A change to this field affects
 only fields added afterwards, and does not alter the existing fields. The following values are
 supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to
 case-sensitive behavior.

Returns:
value or null for none








setDefaultCollation
public Table setDefaultCollation(String defaultCollation)
Optional. Defines the default collation specification of new STRING fields in the table. During
 table creation or update, if a STRING field is added to this table without explicit collation
 specified, then the table inherits the table default collation. A change to this field affects
 only fields added afterwards, and does not alter the existing fields. The following values are
 supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to
 case-sensitive behavior.

Parameters:
defaultCollation - defaultCollation or null for none








getDefaultRoundingMode
public String getDefaultRoundingMode()
Optional. Defines the default rounding mode specification of new decimal fields (NUMERIC OR
 BIGNUMERIC) in the table. During table creation or update, if a decimal field is added to this
 table without an explicit rounding mode specified, then the field inherits the table default
 rounding mode. Changing this field doesn't affect existing fields.

Returns:
value or null for none








setDefaultRoundingMode
public Table setDefaultRoundingMode(String defaultRoundingMode)
Optional. Defines the default rounding mode specification of new decimal fields (NUMERIC OR
 BIGNUMERIC) in the table. During table creation or update, if a decimal field is added to this
 table without an explicit rounding mode specified, then the field inherits the table default
 rounding mode. Changing this field doesn't affect existing fields.

Parameters:
defaultRoundingMode - defaultRoundingMode or null for none








getDescription
public String getDescription()
Optional. A user-friendly description of this table.

Returns:
value or null for none








setDescription
public Table setDescription(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 String getEtag()
Output only. A hash of this resource.

Returns:
value or null for none








setEtag
public Table setEtag(String etag)
Output only. A hash of this resource.

Parameters:
etag - etag or null for none








getExpirationTime
public 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(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








getExternalCatalogTableOptions
public ExternalCatalogTableOptions getExternalCatalogTableOptions()
Optional. Options defining open source compatible table.

Returns:
value or null for none








setExternalCatalogTableOptions
public Table setExternalCatalogTableOptions(ExternalCatalogTableOptions externalCatalogTableOptions)
Optional. Options defining open source compatible table.

Parameters:
externalCatalogTableOptions - externalCatalogTableOptions 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 String getFriendlyName()
Optional. A descriptive name for this table.

Returns:
value or null for none








setFriendlyName
public Table setFriendlyName(String friendlyName)
Optional. A descriptive name for this table.

Parameters:
friendlyName - friendlyName or null for none








getId
public String getId()
Output only. An opaque ID uniquely identifying the table.

Returns:
value or null for none








setId
public Table setId(String id)
Output only. An opaque ID uniquely identifying the table.

Parameters:
id - id or null for none








getKind
public String getKind()
The type of resource ID.

Returns:
value or null for none








setKind
public Table setKind(String kind)
The type of resource ID.

Parameters:
kind - kind or null for none








getLabels
public Map<String,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(Map<String,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 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(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 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(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








getMaterializedView
public MaterializedViewDefinition getMaterializedView()
Optional. The materialized view definition.

Returns:
value or null for none








setMaterializedView
public Table setMaterializedView(MaterializedViewDefinition materializedView)
Optional. The materialized view definition.

Parameters:
materializedView - materializedView or null for none








getMaterializedViewStatus
public MaterializedViewStatus getMaterializedViewStatus()
Output only. The materialized view status.

Returns:
value or null for none








setMaterializedViewStatus
public Table setMaterializedViewStatus(MaterializedViewStatus materializedViewStatus)
Output only. The materialized view status.

Parameters:
materializedViewStatus - materializedViewStatus or null for none








getMaxStaleness
public String getMaxStaleness()
Optional. The maximum staleness of data that could be returned when the table (or stale MV) is
 queried. Staleness encoded as a string encoding of sql IntervalValue type.

Returns:
value or null for none








setMaxStaleness
public Table setMaxStaleness(String maxStaleness)
Optional. The maximum staleness of data that could be returned when the table (or stale MV) is
 queried. Staleness encoded as a string encoding of sql IntervalValue type.

Parameters:
maxStaleness - maxStaleness or null for none








getModel
public ModelDefinition getModel()
Deprecated.

Returns:
value or null for none








setModel
public Table setModel(ModelDefinition model)
Deprecated.

Parameters:
model - model or null for none








getNumActiveLogicalBytes
public Long getNumActiveLogicalBytes()
Output only. Number of logical bytes that are less than 90 days old.

Returns:
value or null for none








setNumActiveLogicalBytes
public Table setNumActiveLogicalBytes(Long numActiveLogicalBytes)
Output only. Number of logical bytes that are less than 90 days old.

Parameters:
numActiveLogicalBytes - numActiveLogicalBytes or null for none








getNumActivePhysicalBytes
public Long getNumActivePhysicalBytes()
Output only. Number of physical bytes less than 90 days old. This data is not kept in real
 time, and might be delayed by a few seconds to a few minutes.

Returns:
value or null for none








setNumActivePhysicalBytes
public Table setNumActivePhysicalBytes(Long numActivePhysicalBytes)
Output only. Number of physical bytes less than 90 days old. This data is not kept in real
 time, and might be delayed by a few seconds to a few minutes.

Parameters:
numActivePhysicalBytes - numActivePhysicalBytes or null for none








getNumBytes
public Long getNumBytes()
Output only. The size of this table in logical bytes, excluding any data in the streaming
 buffer.

Returns:
value or null for none








setNumBytes
public Table setNumBytes(Long numBytes)
Output only. The size of this table in logical bytes, excluding any data in the streaming
 buffer.

Parameters:
numBytes - numBytes or null for none








getNumCurrentPhysicalBytes
public Long getNumCurrentPhysicalBytes()
Output only. Number of physical bytes used by current live data storage. This data is not kept
 in real time, and might be delayed by a few seconds to a few minutes.

Returns:
value or null for none








setNumCurrentPhysicalBytes
public Table setNumCurrentPhysicalBytes(Long numCurrentPhysicalBytes)
Output only. Number of physical bytes used by current live data storage. This data is not kept
 in real time, and might be delayed by a few seconds to a few minutes.

Parameters:
numCurrentPhysicalBytes - numCurrentPhysicalBytes or null for none








getNumLongTermBytes
public Long getNumLongTermBytes()
Output only. The number of logical bytes in the table that are considered "long-term storage".

Returns:
value or null for none








setNumLongTermBytes
public Table setNumLongTermBytes(Long numLongTermBytes)
Output only. The number of logical bytes in the table that are considered "long-term storage".

Parameters:
numLongTermBytes - numLongTermBytes or null for none








getNumLongTermLogicalBytes
public Long getNumLongTermLogicalBytes()
Output only. Number of logical bytes that are more than 90 days old.

Returns:
value or null for none








setNumLongTermLogicalBytes
public Table setNumLongTermLogicalBytes(Long numLongTermLogicalBytes)
Output only. Number of logical bytes that are more than 90 days old.

Parameters:
numLongTermLogicalBytes - numLongTermLogicalBytes or null for none








getNumLongTermPhysicalBytes
public Long getNumLongTermPhysicalBytes()
Output only. Number of physical bytes more than 90 days old. This data is not kept in real
 time, and might be delayed by a few seconds to a few minutes.

Returns:
value or null for none








setNumLongTermPhysicalBytes
public Table setNumLongTermPhysicalBytes(Long numLongTermPhysicalBytes)
Output only. Number of physical bytes more than 90 days old. This data is not kept in real
 time, and might be delayed by a few seconds to a few minutes.

Parameters:
numLongTermPhysicalBytes - numLongTermPhysicalBytes or null for none








getNumPartitions
public Long getNumPartitions()
Output only. The number of partitions present in the table or materialized view. This data is
 not kept in real time, and might be delayed by a few seconds to a few minutes.

Returns:
value or null for none








setNumPartitions
public Table setNumPartitions(Long numPartitions)
Output only. The number of partitions present in the table or materialized view. This data is
 not kept in real time, and might be delayed by a few seconds to a few minutes.

Parameters:
numPartitions - numPartitions or null for none








getNumPhysicalBytes
public Long getNumPhysicalBytes()
Output only. The physical size of this table in bytes. This includes storage used for time
 travel.

Returns:
value or null for none








setNumPhysicalBytes
public Table setNumPhysicalBytes(Long numPhysicalBytes)
Output only. The physical size of this table in bytes. This includes storage used for time
 travel.

Parameters:
numPhysicalBytes - numPhysicalBytes or null for none








getNumRows
public 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(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








getNumTimeTravelPhysicalBytes
public Long getNumTimeTravelPhysicalBytes()
Output only. Number of physical bytes used by time travel storage (deleted or changed data).
 This data is not kept in real time, and might be delayed by a few seconds to a few minutes.

Returns:
value or null for none








setNumTimeTravelPhysicalBytes
public Table setNumTimeTravelPhysicalBytes(Long numTimeTravelPhysicalBytes)
Output only. Number of physical bytes used by time travel storage (deleted or changed data).
 This data is not kept in real time, and might be delayed by a few seconds to a few minutes.

Parameters:
numTimeTravelPhysicalBytes - numTimeTravelPhysicalBytes or null for none








getNumTotalLogicalBytes
public Long getNumTotalLogicalBytes()
Output only. Total number of logical bytes in the table or materialized view.

Returns:
value or null for none








setNumTotalLogicalBytes
public Table setNumTotalLogicalBytes(Long numTotalLogicalBytes)
Output only. Total number of logical bytes in the table or materialized view.

Parameters:
numTotalLogicalBytes - numTotalLogicalBytes or null for none








getNumTotalPhysicalBytes
public Long getNumTotalPhysicalBytes()
Output only. The physical size of this table in bytes. This also includes storage used for time
 travel. This data is not kept in real time, and might be delayed by a few seconds to a few
 minutes.

Returns:
value or null for none








setNumTotalPhysicalBytes
public Table setNumTotalPhysicalBytes(Long numTotalPhysicalBytes)
Output only. The physical size of this table in bytes. This also includes storage used for time
 travel. This data is not kept in real time, and might be delayed by a few seconds to a few
 minutes.

Parameters:
numTotalPhysicalBytes - numTotalPhysicalBytes or null for none








getPartitionDefinition
public PartitioningDefinition getPartitionDefinition()
Optional. The partition information for all table formats, including managed partitioned
 tables, hive partitioned tables, iceberg partitioned, and metastore partitioned tables. This
 field is only populated for metastore partitioned tables. For other table formats, this is an
 output only field.

Returns:
value or null for none








setPartitionDefinition
public Table setPartitionDefinition(PartitioningDefinition partitionDefinition)
Optional. The partition information for all table formats, including managed partitioned
 tables, hive partitioned tables, iceberg partitioned, and metastore partitioned tables. This
 field is only populated for metastore partitioned tables. For other table formats, this is an
 output only field.

Parameters:
partitionDefinition - partitionDefinition or null for none








getRangePartitioning
public RangePartitioning getRangePartitioning()
If specified, configures range partitioning for this table.

Returns:
value or null for none








setRangePartitioning
public Table setRangePartitioning(RangePartitioning rangePartitioning)
If specified, configures range partitioning for this table.

Parameters:
rangePartitioning - rangePartitioning or null for none








getReplicas
public List<TableReference> getReplicas()
Optional. Output only. Table references of all replicas currently active on the table.

Returns:
value or null for none








setReplicas
public Table setReplicas(List<TableReference> replicas)
Optional. Output only. Table references of all replicas currently active on the table.

Parameters:
replicas - replicas or null for none








getRequirePartitionFilter
public Boolean getRequirePartitionFilter()
Optional. If set to true, queries over this table require a partition filter that can be used
 for partition elimination to be specified.

Returns:
value or null for none








setRequirePartitionFilter
public Table setRequirePartitionFilter(Boolean requirePartitionFilter)
Optional. If set to true, queries over this table require a partition filter that can be used
 for partition elimination to be specified.

Parameters:
requirePartitionFilter - requirePartitionFilter or null for none








isRequirePartitionFilter
public boolean isRequirePartitionFilter()
Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

 

 Boolean properties can have four possible values:
 null, Data.NULL_BOOLEAN, Boolean.TRUE
 or Boolean.FALSE.
 

 

 This method returns Boolean.TRUE if the default of the property is Boolean.TRUE
 and it is null or Data.NULL_BOOLEAN.
 Boolean.FALSE is returned if the default of the property is Boolean.FALSE and
 it is null or Data.NULL_BOOLEAN.
 

 

 Optional. If set to true, queries over this table require a partition filter that can be used for
 partition elimination to be specified.
 







getResourceTags
public Map<String,String> getResourceTags()
[Optional] The tags associated with this table. Tag keys are globally unique. See additional
 information on [tags](https://cloud.google.com/iam/docs/tags-access-control#definitions). An
 object containing a list of "key": value pairs. The key is the namespaced friendly name of the
 tag key, e.g. "12345/environment" where 12345 is parent id. The value is the friendly short
 name of the tag value, e.g. "production".

Returns:
value or null for none








setResourceTags
public Table setResourceTags(Map<String,String> resourceTags)
[Optional] The tags associated with this table. Tag keys are globally unique. See additional
 information on [tags](https://cloud.google.com/iam/docs/tags-access-control#definitions). An
 object containing a list of "key": value pairs. The key is the namespaced friendly name of the
 tag key, e.g. "12345/environment" where 12345 is parent id. The value is the friendly short
 name of the tag value, e.g. "production".

Parameters:
resourceTags - resourceTags or null for none








getRestrictions
public RestrictionConfig getRestrictions()
Optional. Output only. Restriction config for table. If set, restrict certain accesses on the
 table based on the config. See [Data egress](/bigquery/docs/analytics-hub-
 introduction#data_egress) for more details.

Returns:
value or null for none








setRestrictions
public Table setRestrictions(RestrictionConfig restrictions)
Optional. Output only. Restriction config for table. If set, restrict certain accesses on the
 table based on the config. See [Data egress](/bigquery/docs/analytics-hub-
 introduction#data_egress) for more details.

Parameters:
restrictions - restrictions 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 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(String selfLink)
Output only. A URL that can be used to access this resource again.

Parameters:
selfLink - selfLink or null for none








getSnapshotDefinition
public SnapshotDefinition getSnapshotDefinition()
Output only. Contains information about the snapshot. This value is set via snapshot creation.

Returns:
value or null for none








setSnapshotDefinition
public Table setSnapshotDefinition(SnapshotDefinition snapshotDefinition)
Output only. Contains information about the snapshot. This value is set via snapshot creation.

Parameters:
snapshotDefinition - snapshotDefinition 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








getTableConstraints
public TableConstraints getTableConstraints()
Optional. Tables Primary Key and Foreign Key information

Returns:
value or null for none








setTableConstraints
public Table setTableConstraints(TableConstraints tableConstraints)
Optional. Tables Primary Key and Foreign Key information

Parameters:
tableConstraints - tableConstraints 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








getTableReplicationInfo
public TableReplicationInfo getTableReplicationInfo()
Optional. Table replication info for table created `AS REPLICA` DDL like: `CREATE MATERIALIZED
 VIEW mv1 AS REPLICA OF src_mv`

Returns:
value or null for none








setTableReplicationInfo
public Table setTableReplicationInfo(TableReplicationInfo tableReplicationInfo)
Optional. Table replication info for table created `AS REPLICA` DDL like: `CREATE MATERIALIZED
 VIEW mv1 AS REPLICA OF src_mv`

Parameters:
tableReplicationInfo - tableReplicationInfo or null for none








getTimePartitioning
public TimePartitioning getTimePartitioning()
If specified, configures time-based partitioning for this table.

Returns:
value or null for none








setTimePartitioning
public Table setTimePartitioning(TimePartitioning timePartitioning)
If specified, configures time-based partitioning for this table.

Parameters:
timePartitioning - timePartitioning or null for none








getType
public 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. *
 `MATERIALIZED_VIEW`: A precomputed view defined by a SQL query. * `SNAPSHOT`: An immutable
 BigQuery table that preserves the contents of a base table at a particular time. See additional
 information on [table snapshots](/bigquery/docs/table-snapshots-intro). The default value is
 `TABLE`.

Returns:
value or null for none








setType
public Table setType(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. *
 `MATERIALIZED_VIEW`: A precomputed view defined by a SQL query. * `SNAPSHOT`: An immutable
 BigQuery table that preserves the contents of a base table at a particular time. See additional
 information on [table snapshots](/bigquery/docs/table-snapshots-intro). 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(String fieldName,
                 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














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.