Package com.google.cloud.bigquery
Class StandardTableDefinition
- java.lang.Object
-
- com.google.cloud.bigquery.TableDefinition
-
- com.google.cloud.bigquery.StandardTableDefinition
-
- All Implemented Interfaces:
Serializable
public abstract class StandardTableDefinition extends TableDefinition
A Google BigQuery default table definition. This definition is used for standard, two-dimensional tables with individual records organized in rows, and a data type assigned to each column (also called a field). Individual fields within a record may contain nested and repeated children fields. Every table is described by a schema that describes field names, types, and other information.- See Also:
- Managing Tables, Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
StandardTableDefinition.Builder
static class
StandardTableDefinition.StreamingBuffer
Google BigQuery Table's Streaming Buffer information.-
Nested classes/interfaces inherited from class com.google.cloud.bigquery.TableDefinition
TableDefinition.Type
-
-
Constructor Summary
Constructors Constructor Description StandardTableDefinition()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract Clustering
getClustering()
Returns the clustering configuration for this table.abstract String
getLocation()
Returns the geographic location where the table should reside.abstract Long
getNumActiveLogicalBytes()
Returns the number of active logical bytes.abstract Long
getNumActivePhysicalBytes()
Returns the number of active physical bytes.abstract Long
getNumBytes()
Returns the size of this table in bytes, excluding any data in the streaming buffer.abstract Long
getNumLongTermBytes()
Returns the number of bytes considered "long-term storage" for reduced billing purposes.abstract Long
getNumLongTermLogicalBytes()
Returns the number of long term logical bytes.abstract Long
getNumLongTermPhysicalBytes()
Returns the number of long term physical bytes.abstract Long
getNumRows()
Returns the number of rows in this table, excluding any data in the streaming buffer.abstract Long
getNumTimeTravelPhysicalBytes()
Returns the number of time travel physical bytes.abstract Long
getNumTotalLogicalBytes()
Returns the number of total logical bytes.abstract Long
getNumTotalPhysicalBytes()
Returns the number of total physical bytes.abstract RangePartitioning
getRangePartitioning()
Returns the range partitioning configuration for this table.abstract StandardTableDefinition.StreamingBuffer
getStreamingBuffer()
Returns information on the table's streaming buffer if any exists.abstract TableConstraints
getTableConstraints()
Returns the table constraints for this table.abstract TimePartitioning
getTimePartitioning()
Returns the time partitioning configuration for this table.static StandardTableDefinition.Builder
newBuilder()
Returns a builder for a BigQuery standard table definition.static StandardTableDefinition
of(Schema schema)
Creates a BigQuery standard table definition given its schema.abstract StandardTableDefinition.Builder
toBuilder()
Returns a builder for theStandardTableDefinition
object.-
Methods inherited from class com.google.cloud.bigquery.TableDefinition
getSchema, getType
-
-
-
-
Method Detail
-
getNumBytes
@Nullable public abstract Long getNumBytes()
Returns the size of this table in bytes, excluding any data in the streaming buffer.
-
getNumLongTermBytes
@Nullable public abstract Long getNumLongTermBytes()
Returns the number of bytes considered "long-term storage" for reduced billing purposes.- See Also:
- Long Term Storage Pricing
-
getNumTimeTravelPhysicalBytes
@Nullable public abstract Long getNumTimeTravelPhysicalBytes()
Returns the number of time travel physical bytes.- See Also:
- Storage Pricing
-
getNumTotalLogicalBytes
@Nullable public abstract Long getNumTotalLogicalBytes()
Returns the number of total logical bytes.- See Also:
- Storage Pricing
-
getNumActiveLogicalBytes
@Nullable public abstract Long getNumActiveLogicalBytes()
Returns the number of active logical bytes.- See Also:
- Storage Pricing
-
getNumLongTermLogicalBytes
@Nullable public abstract Long getNumLongTermLogicalBytes()
Returns the number of long term logical bytes.- See Also:
- Storage Pricing
-
getNumTotalPhysicalBytes
@Nullable public abstract Long getNumTotalPhysicalBytes()
Returns the number of total physical bytes.- See Also:
- Storage Pricing
-
getNumActivePhysicalBytes
@Nullable public abstract Long getNumActivePhysicalBytes()
Returns the number of active physical bytes.- See Also:
- Storage Pricing
-
getNumLongTermPhysicalBytes
@Nullable public abstract Long getNumLongTermPhysicalBytes()
Returns the number of long term physical bytes.- See Also:
- Storage Pricing
-
getNumRows
@Nullable public abstract Long getNumRows()
Returns the number of rows in this table, excluding any data in the streaming buffer.
-
getLocation
@Nullable public abstract String getLocation()
Returns the geographic location where the table should reside. This value is inherited from the dataset.- See Also:
- Dataset Location
-
getStreamingBuffer
@Nullable public abstract StandardTableDefinition.StreamingBuffer getStreamingBuffer()
Returns information on the table's streaming buffer if any exists. Returnsnull
if no streaming buffer exists.
-
getTimePartitioning
@Nullable public abstract TimePartitioning getTimePartitioning()
Returns the time partitioning configuration for this table. Ifnull
, the table is not time-partitioned.
-
getRangePartitioning
@Nullable public abstract RangePartitioning getRangePartitioning()
Returns the range partitioning configuration for this table. Ifnull
, the table is not range-partitioned.
-
getClustering
@Nullable public abstract Clustering getClustering()
Returns the clustering configuration for this table. Ifnull
, the table is not clustered.
-
getTableConstraints
@Nullable public abstract TableConstraints getTableConstraints()
Returns the table constraints for this table. Returnsnull
if no table constraints are set for this table.
-
newBuilder
public static StandardTableDefinition.Builder newBuilder()
Returns a builder for a BigQuery standard table definition.
-
of
public static StandardTableDefinition of(Schema schema)
Creates a BigQuery standard table definition given its schema.- Parameters:
schema
- the schema of the table
-
toBuilder
public abstract StandardTableDefinition.Builder toBuilder()
Returns a builder for theStandardTableDefinition
object.- Specified by:
toBuilder
in classTableDefinition
-
-