Struct google_api_proto::google::cloud::bigquery::v2::Table

pub struct Table {

    pub kind: String,
    pub etag: String,
    pub id: String,
    pub self_link: String,
    pub table_reference: Option<TableReference>,
    pub friendly_name: Option<String>,
    pub description: Option<String>,
    pub labels: BTreeMap<String, String>,
    pub schema: Option<TableSchema>,
    pub time_partitioning: Option<TimePartitioning>,
    pub range_partitioning: Option<RangePartitioning>,
    pub clustering: Option<Clustering>,
    pub require_partition_filter: Option<bool>,
    pub partition_definition: Option<PartitioningDefinition>,
    pub num_bytes: Option<i64>,
    pub num_physical_bytes: Option<i64>,
    pub num_long_term_bytes: Option<i64>,
    pub num_rows: Option<u64>,
    pub creation_time: i64,
    pub expiration_time: Option<i64>,
    pub last_modified_time: u64,
    pub type: String,
    pub view: Option<ViewDefinition>,
    pub materialized_view: Option<MaterializedViewDefinition>,
    pub materialized_view_status: Option<MaterializedViewStatus>,
    pub external_data_configuration: Option<ExternalDataConfiguration>,
    pub biglake_configuration: Option<BigLakeConfiguration>,
    pub location: String,
    pub streaming_buffer: Option<Streamingbuffer>,
    pub encryption_configuration: Option<EncryptionConfiguration>,
    pub snapshot_definition: Option<SnapshotDefinition>,
    pub default_collation: Option<String>,
    pub default_rounding_mode: i32,
    pub clone_definition: Option<CloneDefinition>,
    pub num_time_travel_physical_bytes: Option<i64>,
    pub num_total_logical_bytes: Option<i64>,
    pub num_active_logical_bytes: Option<i64>,
    pub num_long_term_logical_bytes: Option<i64>,
    pub num_current_physical_bytes: Option<i64>,
    pub num_total_physical_bytes: Option<i64>,
    pub num_active_physical_bytes: Option<i64>,
    pub num_long_term_physical_bytes: Option<i64>,
    pub num_partitions: Option<i64>,
    pub max_staleness: String,
    pub restrictions: Option<RestrictionConfig>,
    pub table_constraints: Option<TableConstraints>,
    pub resource_tags: BTreeMap<String, String>,
    pub table_replication_info: Option<TableReplicationInfo>,
    pub replicas: Vec<TableReference>,
    pub external_catalog_table_options: Option<ExternalCatalogTableOptions>,
}

Fields

kind: String

The type of resource ID.

etag: String

Output only. A hash of this resource.

id: String

Output only. An opaque ID uniquely identifying the table.

self_link: String

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

table_reference: Option<TableReference>

Required. Reference describing the ID of this table.

friendly_name: Option<String>

Optional. A descriptive name for this table.

description: Option<String>

Optional. A user-friendly description of this table.

labels: BTreeMap<String, String>

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.

schema: Option<TableSchema>

Optional. Describes the schema of this table.

time_partitioning: Option<TimePartitioning>

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

range_partitioning: Option<RangePartitioning>

If specified, configures range partitioning for this table.

clustering: Option<Clustering>

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

require_partition_filter: Option<bool>

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

partition_definition: Option<PartitioningDefinition>

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.

num_bytes: Option<i64>

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

num_physical_bytes: Option<i64>

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

num_long_term_bytes: Option<i64>

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

num_rows: Option<u64>

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

creation_time: i64

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

expiration_time: Option<i64>

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.

last_modified_time: u64

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

type: String

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.

view: Option<ViewDefinition>

Optional. The view definition.

materialized_view: Option<MaterializedViewDefinition>

Optional. The materialized view definition.

materialized_view_status: Option<MaterializedViewStatus>

Output only. The materialized view status.

external_data_configuration: Option<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.

biglake_configuration: Option<BigLakeConfiguration>

Optional. Specifies the configuration of a BigLake managed table.

location: String

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

streaming_buffer: Option<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.

encryption_configuration: Option<EncryptionConfiguration>

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

snapshot_definition: Option<SnapshotDefinition>

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

default_collation: Option<String>

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.

default_rounding_mode: i32

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.

clone_definition: Option<CloneDefinition>

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

num_time_travel_physical_bytes: Option<i64>

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.

num_total_logical_bytes: Option<i64>

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

num_active_logical_bytes: Option<i64>

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

num_long_term_logical_bytes: Option<i64>

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

num_current_physical_bytes: Option<i64>

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.

num_total_physical_bytes: Option<i64>

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.

num_active_physical_bytes: Option<i64>

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.

num_long_term_physical_bytes: Option<i64>

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.

num_partitions: Option<i64>

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.

max_staleness: String

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.

restrictions: Option<RestrictionConfig>

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.

table_constraints: Option<TableConstraints>

Optional. Tables Primary Key and Foreign Key information

resource_tags: BTreeMap<String, String>

Optional. The tags attached to this table. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example “123456789012/environment” where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example “Production”. See Tag definitions for more details.

table_replication_info: Option<TableReplicationInfo>

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

replicas: Vec<TableReference>

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

external_catalog_table_options: Option<ExternalCatalogTableOptions>

Optional. Options defining open source compatible table.

Implementations

impl Table

pub fn default_rounding_mode(&self) -> RoundingMode

Returns the enum value of default_rounding_mode, or the default if the field is set to an invalid enum value.

pub fn set_default_rounding_mode(&mut self, value: RoundingMode)

Sets default_rounding_mode to the provided enum value.

Trait Implementations

impl Clone for Table

fn clone(&self) -> Table

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Table

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Table

fn default() -> Self

Returns the “default value” for a type.

impl Message for Table

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Table

fn eq(&self, other: &Table) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Table