Show / Hide Table of Contents

Class Table

Inheritance
object
Table
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Bigquery.v2.Data
Assembly: Google.Apis.Bigquery.v2.dll
Syntax
public class Table : IDirectResponseSchema

Properties

BiglakeConfiguration

Optional. Specifies the configuration of a BigQuery table for Apache Iceberg.

Declaration
[JsonProperty("biglakeConfiguration")]
public virtual BigLakeConfiguration BiglakeConfiguration { get; set; }
Property Value
Type Description
BigLakeConfiguration

CloneDefinition

Output only. Contains information about the clone. This value is set via the clone operation.

Declaration
[JsonProperty("cloneDefinition")]
public virtual CloneDefinition CloneDefinition { get; set; }
Property Value
Type Description
CloneDefinition

Clustering

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

Declaration
[JsonProperty("clustering")]
public virtual Clustering Clustering { get; set; }
Property Value
Type Description
Clustering

CreationTime

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

Declaration
[JsonProperty("creationTime")]
public virtual long? CreationTime { get; set; }
Property Value
Type Description
long?

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.

Declaration
[JsonProperty("defaultCollation")]
public virtual string DefaultCollation { get; set; }
Property Value
Type Description
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.

Declaration
[JsonProperty("defaultRoundingMode")]
public virtual string DefaultRoundingMode { get; set; }
Property Value
Type Description
string

Description

Optional. A user-friendly description of this table.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

ETag

Output only. A hash of this resource.

Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }
Property Value
Type Description
string

EncryptionConfiguration

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

Declaration
[JsonProperty("encryptionConfiguration")]
public virtual EncryptionConfiguration EncryptionConfiguration { get; set; }
Property Value
Type Description
EncryptionConfiguration

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.

Declaration
[JsonProperty("expirationTime")]
public virtual long? ExpirationTime { get; set; }
Property Value
Type Description
long?

ExternalCatalogTableOptions

Optional. Options defining open source compatible table.

Declaration
[JsonProperty("externalCatalogTableOptions")]
public virtual ExternalCatalogTableOptions ExternalCatalogTableOptions { get; set; }
Property Value
Type Description
ExternalCatalogTableOptions

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.

Declaration
[JsonProperty("externalDataConfiguration")]
public virtual ExternalDataConfiguration ExternalDataConfiguration { get; set; }
Property Value
Type Description
ExternalDataConfiguration

FriendlyName

Optional. A descriptive name for this table.

Declaration
[JsonProperty("friendlyName")]
public virtual string FriendlyName { get; set; }
Property Value
Type Description
string

Id

Output only. An opaque ID uniquely identifying the table.

Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type Description
string

Kind

The type of resource ID.

Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
Type Description
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.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

LastModifiedTime

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

Declaration
[JsonProperty("lastModifiedTime")]
public virtual ulong? LastModifiedTime { get; set; }
Property Value
Type Description
ulong?

Location

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

Declaration
[JsonProperty("location")]
public virtual string Location { get; set; }
Property Value
Type Description
string

ManagedTableType

Optional. If set, overrides the default managed table type configured in the dataset.

Declaration
[JsonProperty("managedTableType")]
public virtual string ManagedTableType { get; set; }
Property Value
Type Description
string

MaterializedView

Optional. The materialized view definition.

Declaration
[JsonProperty("materializedView")]
public virtual MaterializedViewDefinition MaterializedView { get; set; }
Property Value
Type Description
MaterializedViewDefinition

MaterializedViewStatus

Output only. The materialized view status.

Declaration
[JsonProperty("materializedViewStatus")]
public virtual MaterializedViewStatus MaterializedViewStatus { get; set; }
Property Value
Type Description
MaterializedViewStatus

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.

Declaration
[JsonProperty("maxStaleness")]
public virtual string MaxStaleness { get; set; }
Property Value
Type Description
string

Model

Deprecated.

Declaration
[JsonProperty("model")]
public virtual ModelDefinition Model { get; set; }
Property Value
Type Description
ModelDefinition

NumActiveLogicalBytes

Output only. Number of logical bytes that are less than 90 days old.

Declaration
[JsonProperty("numActiveLogicalBytes")]
public virtual long? NumActiveLogicalBytes { get; set; }
Property Value
Type Description
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.

Declaration
[JsonProperty("numActivePhysicalBytes")]
public virtual long? NumActivePhysicalBytes { get; set; }
Property Value
Type Description
long?

NumBytes

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

Declaration
[JsonProperty("numBytes")]
public virtual long? NumBytes { get; set; }
Property Value
Type Description
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.

Declaration
[JsonProperty("numCurrentPhysicalBytes")]
public virtual long? NumCurrentPhysicalBytes { get; set; }
Property Value
Type Description
long?

NumLongTermBytes

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

Declaration
[JsonProperty("numLongTermBytes")]
public virtual long? NumLongTermBytes { get; set; }
Property Value
Type Description
long?

NumLongTermLogicalBytes

Output only. Number of logical bytes that are more than 90 days old.

Declaration
[JsonProperty("numLongTermLogicalBytes")]
public virtual long? NumLongTermLogicalBytes { get; set; }
Property Value
Type Description
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.

Declaration
[JsonProperty("numLongTermPhysicalBytes")]
public virtual long? NumLongTermPhysicalBytes { get; set; }
Property Value
Type Description
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.

Declaration
[JsonProperty("numPartitions")]
public virtual long? NumPartitions { get; set; }
Property Value
Type Description
long?

NumPhysicalBytes

Output only. The physical size of this table in bytes. This includes storage used for time travel.

Declaration
[JsonProperty("numPhysicalBytes")]
public virtual long? NumPhysicalBytes { get; set; }
Property Value
Type Description
long?

NumRows

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

Declaration
[JsonProperty("numRows")]
public virtual ulong? NumRows { get; set; }
Property Value
Type Description
ulong?

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.

Declaration
[JsonProperty("numTimeTravelPhysicalBytes")]
public virtual long? NumTimeTravelPhysicalBytes { get; set; }
Property Value
Type Description
long?

NumTotalLogicalBytes

Output only. Total number of logical bytes in the table or materialized view.

Declaration
[JsonProperty("numTotalLogicalBytes")]
public virtual long? NumTotalLogicalBytes { get; set; }
Property Value
Type Description
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.

Declaration
[JsonProperty("numTotalPhysicalBytes")]
public virtual long? NumTotalPhysicalBytes { get; set; }
Property Value
Type Description
long?

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.

Declaration
[JsonProperty("partitionDefinition")]
public virtual PartitioningDefinition PartitionDefinition { get; set; }
Property Value
Type Description
PartitioningDefinition

RangePartitioning

If specified, configures range partitioning for this table.

Declaration
[JsonProperty("rangePartitioning")]
public virtual RangePartitioning RangePartitioning { get; set; }
Property Value
Type Description
RangePartitioning

Replicas

Optional. Output only. Table references of all replicas currently active on the table.

Declaration
[JsonProperty("replicas")]
public virtual IList<TableReference> Replicas { get; set; }
Property Value
Type Description
IList<TableReference>

RequirePartitionFilter

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

Declaration
[JsonProperty("requirePartitionFilter")]
public virtual bool? RequirePartitionFilter { get; set; }
Property Value
Type Description
bool?

ResourceTags

[Optional] The tags associated with this table. Tag keys are globally unique. See additional information on tags. 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".

Declaration
[JsonProperty("resourceTags")]
public virtual IDictionary<string, string> ResourceTags { get; set; }
Property Value
Type Description
IDictionary<string, string>

Restrictions

Optional. Output only. Restriction config for table. If set, restrict certain accesses on the table based on the config. See Data egress for more details.

Declaration
[JsonProperty("restrictions")]
public virtual RestrictionConfig Restrictions { get; set; }
Property Value
Type Description
RestrictionConfig

Schema

Optional. Describes the schema of this table.

Declaration
[JsonProperty("schema")]
public virtual TableSchema Schema { get; set; }
Property Value
Type Description
TableSchema

SelfLink

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

Declaration
[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }
Property Value
Type Description
string

SnapshotDefinition

Output only. Contains information about the snapshot. This value is set via snapshot creation.

Declaration
[JsonProperty("snapshotDefinition")]
public virtual SnapshotDefinition SnapshotDefinition { get; set; }
Property Value
Type Description
SnapshotDefinition

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.

Declaration
[JsonProperty("streamingBuffer")]
public virtual Streamingbuffer StreamingBuffer { get; set; }
Property Value
Type Description
Streamingbuffer

TableConstraints

Optional. Tables Primary Key and Foreign Key information

Declaration
[JsonProperty("tableConstraints")]
public virtual TableConstraints TableConstraints { get; set; }
Property Value
Type Description
TableConstraints

TableReference

Required. Reference describing the ID of this table.

Declaration
[JsonProperty("tableReference")]
public virtual TableReference TableReference { get; set; }
Property Value
Type Description
TableReference

TableReplicationInfo

Optional. Table replication info for table created AS REPLICA DDL like: CREATE MATERIALIZED VIEW mv1 AS REPLICA OF src_mv

Declaration
[JsonProperty("tableReplicationInfo")]
public virtual TableReplicationInfo TableReplicationInfo { get; set; }
Property Value
Type Description
TableReplicationInfo

TimePartitioning

If specified, configures time-based partitioning for this table.

Declaration
[JsonProperty("timePartitioning")]
public virtual TimePartitioning TimePartitioning { get; set; }
Property Value
Type Description
TimePartitioning

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. The default value is TABLE.

Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type Description
string

View

Optional. The view definition.

Declaration
[JsonProperty("view")]
public virtual ViewDefinition View { get; set; }
Property Value
Type Description
ViewDefinition

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX