Class: Google::Apis::BigqueryV2::Table

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/bigquery_v2/classes.rb,
lib/google/apis/bigquery_v2/representations.rb,
lib/google/apis/bigquery_v2/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Table

Returns a new instance of Table.



9578
9579
9580
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9578

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#biglake_configuration ⇒ Google::Apis::BigqueryV2::BigLakeConfiguration

Configuration for BigLake managed tables. Corresponds to the JSON property biglakeConfiguration

Returns:



9263
9264
9265
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9263

def biglake_configuration
  @biglake_configuration
end

#clone_definition ⇒ Google::Apis::BigqueryV2::CloneDefinition

Information about base table and clone time of a table clone. Corresponds to the JSON property cloneDefinition

Returns:



9268
9269
9270
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9268

def clone_definition
  @clone_definition
end

#clustering ⇒ Google::Apis::BigqueryV2::Clustering

Configures table clustering. Corresponds to the JSON property clustering

Returns:



9273
9274
9275
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9273

def clustering
  @clustering
end

#creation_time ⇒ Fixnum

Output only. The time when this table was created, in milliseconds since the epoch. Corresponds to the JSON property creationTime

Returns:

  • (Fixnum) 


9279
9280
9281
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9279

def creation_time
  @creation_time
end

#default_collation ⇒ 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. Corresponds to the JSON property defaultCollation

Returns:

  • (String) 


9290
9291
9292
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9290

def default_collation
  @default_collation
end

#default_rounding_mode ⇒ String

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. Corresponds to the JSON property defaultRoundingMode

Returns:

  • (String) 


9299
9300
9301
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9299

def default_rounding_mode
  @default_rounding_mode
end

#description ⇒ String

Optional. A user-friendly description of this table. Corresponds to the JSON property description

Returns:

  • (String) 


9304
9305
9306
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9304

def description
  @description
end

#encryption_configuration ⇒ Google::Apis::BigqueryV2::EncryptionConfiguration

Configuration for Cloud KMS encryption settings. Corresponds to the JSON property encryptionConfiguration

Returns:



9309
9310
9311
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9309

def encryption_configuration
  @encryption_configuration
end

#etag ⇒ String

Output only. A hash of this resource. Corresponds to the JSON property etag

Returns:

  • (String) 


9314
9315
9316
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9314

def etag
  @etag
end

#expiration_time ⇒ Fixnum

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. Corresponds to the JSON property expirationTime

Returns:

  • (Fixnum) 


9323
9324
9325
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9323

def expiration_time
  @expiration_time
end

#external_catalog_table_options ⇒ Google::Apis::BigqueryV2::ExternalCatalogTableOptions

Metadata about open source compatible table. The fields contained in these options correspond to hive metastore's table level properties. Corresponds to the JSON property externalCatalogTableOptions

Returns:



9329
9330
9331
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9329

def external_catalog_table_options
  @external_catalog_table_options
end

#external_data_configuration ⇒ Google::Apis::BigqueryV2::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. Corresponds to the JSON property externalDataConfiguration

Returns:



9336
9337
9338
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9336

def external_data_configuration
  @external_data_configuration
end

#friendly_name ⇒ String

Optional. A descriptive name for this table. Corresponds to the JSON property friendlyName

Returns:

  • (String) 


9341
9342
9343
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9341

def friendly_name
  @friendly_name
end

#id ⇒ String

Output only. An opaque ID uniquely identifying the table. Corresponds to the JSON property id

Returns:

  • (String) 


9346
9347
9348
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9346

def id
  @id
end

#kind ⇒ String

The type of resource ID. Corresponds to the JSON property kind

Returns:

  • (String) 


9351
9352
9353
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9351

def kind
  @kind
end

#labels ⇒ Hash<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. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


9360
9361
9362
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9360

def labels
  @labels
end

#last_modified_time ⇒ Fixnum

Output only. The time when this table was last modified, in milliseconds since the epoch. Corresponds to the JSON property lastModifiedTime

Returns:

  • (Fixnum) 


9366
9367
9368
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9366

def last_modified_time
  @last_modified_time
end

#location ⇒ String

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

Returns:

  • (String) 


9372
9373
9374
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9372

def location
  @location
end

#materialized_view ⇒ Google::Apis::BigqueryV2::MaterializedViewDefinition

Definition and configuration of a materialized view. Corresponds to the JSON property materializedView

Returns:



9377
9378
9379
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9377

def materialized_view
  @materialized_view
end

#materialized_view_status ⇒ Google::Apis::BigqueryV2::MaterializedViewStatus

Status of a materialized view. The last refresh timestamp status is omitted here, but is present in the MaterializedViewDefinition message. Corresponds to the JSON property materializedViewStatus

Returns:



9383
9384
9385
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9383

def materialized_view_status
  @materialized_view_status
end

#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. Corresponds to the JSON property maxStaleness

Returns:

  • (String) 


9390
9391
9392
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9390

def max_staleness
  @max_staleness
end

#model ⇒ Google::Apis::BigqueryV2::ModelDefinition

Deprecated. Corresponds to the JSON property model

Returns:



9395
9396
9397
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9395

def model
  @model
end

#num_active_logical_bytes ⇒ Fixnum

Output only. Number of logical bytes that are less than 90 days old. Corresponds to the JSON property numActiveLogicalBytes

Returns:

  • (Fixnum) 


9400
9401
9402
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9400

def num_active_logical_bytes
  @num_active_logical_bytes
end

#num_active_physical_bytes ⇒ Fixnum

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. Corresponds to the JSON property numActivePhysicalBytes

Returns:

  • (Fixnum) 


9406
9407
9408
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9406

def num_active_physical_bytes
  @num_active_physical_bytes
end

#num_bytes ⇒ Fixnum

Output only. The size of this table in logical bytes, excluding any data in the streaming buffer. Corresponds to the JSON property numBytes

Returns:

  • (Fixnum) 


9412
9413
9414
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9412

def num_bytes
  @num_bytes
end

#num_current_physical_bytes ⇒ Fixnum

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. Corresponds to the JSON property numCurrentPhysicalBytes

Returns:

  • (Fixnum) 


9419
9420
9421
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9419

def num_current_physical_bytes
  @num_current_physical_bytes
end

#num_long_term_bytes ⇒ Fixnum

Output only. The number of logical bytes in the table that are considered " long-term storage". Corresponds to the JSON property numLongTermBytes

Returns:

  • (Fixnum) 


9425
9426
9427
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9425

def num_long_term_bytes
  @num_long_term_bytes
end

#num_long_term_logical_bytes ⇒ Fixnum

Output only. Number of logical bytes that are more than 90 days old. Corresponds to the JSON property numLongTermLogicalBytes

Returns:

  • (Fixnum) 


9430
9431
9432
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9430

def num_long_term_logical_bytes
  @num_long_term_logical_bytes
end

#num_long_term_physical_bytes ⇒ Fixnum

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. Corresponds to the JSON property numLongTermPhysicalBytes

Returns:

  • (Fixnum) 


9436
9437
9438
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9436

def num_long_term_physical_bytes
  @num_long_term_physical_bytes
end

#num_partitions ⇒ Fixnum

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. Corresponds to the JSON property numPartitions

Returns:

  • (Fixnum) 


9443
9444
9445
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9443

def num_partitions
  @num_partitions
end

#num_physical_bytes ⇒ Fixnum

Output only. The physical size of this table in bytes. This includes storage used for time travel. Corresponds to the JSON property numPhysicalBytes

Returns:

  • (Fixnum) 


9449
9450
9451
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9449

def num_physical_bytes
  @num_physical_bytes
end

#num_rows ⇒ Fixnum

Output only. The number of rows of data in this table, excluding any data in the streaming buffer. Corresponds to the JSON property numRows

Returns:

  • (Fixnum) 


9455
9456
9457
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9455

def num_rows
  @num_rows
end

#num_time_travel_physical_bytes ⇒ Fixnum

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. Corresponds to the JSON property numTimeTravelPhysicalBytes

Returns:

  • (Fixnum) 


9462
9463
9464
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9462

def num_time_travel_physical_bytes
  @num_time_travel_physical_bytes
end

#num_total_logical_bytes ⇒ Fixnum

Output only. Total number of logical bytes in the table or materialized view. Corresponds to the JSON property numTotalLogicalBytes

Returns:

  • (Fixnum) 


9467
9468
9469
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9467

def num_total_logical_bytes
  @num_total_logical_bytes
end

#num_total_physical_bytes ⇒ Fixnum

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. Corresponds to the JSON property numTotalPhysicalBytes

Returns:

  • (Fixnum) 


9474
9475
9476
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9474

def num_total_physical_bytes
  @num_total_physical_bytes
end

#partition_definition ⇒ Google::Apis::BigqueryV2::PartitioningDefinition

The partitioning information, which includes managed table, external table and metastore partitioned table partition information. Corresponds to the JSON property partitionDefinition

Returns:



9480
9481
9482
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9480

def partition_definition
  @partition_definition
end

#range_partitioning ⇒ Google::Apis::BigqueryV2::RangePartitioning

If specified, configures range partitioning for this table. Corresponds to the JSON property rangePartitioning

Returns:



9485
9486
9487
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9485

def range_partitioning
  @range_partitioning
end

#replicas ⇒ Array<Google::Apis::BigqueryV2::TableReference>

Optional. Output only. Table references of all replicas currently active on the table. Corresponds to the JSON property replicas

Returns:



9491
9492
9493
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9491

def replicas
  @replicas
end

#require_partition_filter ⇒ Boolean Also known as: require_partition_filter?

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

Returns:

  • (Boolean) 


9497
9498
9499
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9497

def require_partition_filter
  @require_partition_filter
end

#resource_tags ⇒ Hash<String,String>

[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". Corresponds to the JSON property resourceTags

Returns:

  • (Hash<String,String>) 


9508
9509
9510
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9508

def resource_tags
  @resource_tags
end

#restrictions ⇒ Google::Apis::BigqueryV2::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. Corresponds to the JSON property restrictions

Returns:



9516
9517
9518
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9516

def restrictions
  @restrictions
end

#schema ⇒ Google::Apis::BigqueryV2::TableSchema

Schema of a table Corresponds to the JSON property schema

Returns:



9521
9522
9523
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9521

def schema
  @schema
end

#self_link ⇒ String

Output only. A URL that can be used to access this resource again. Corresponds to the JSON property selfLink

Returns:

  • (String) 


9526
9527
9528
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9526

def self_link
  @self_link
end

#snapshot_definition ⇒ Google::Apis::BigqueryV2::SnapshotDefinition

Information about base table and snapshot time of the snapshot. Corresponds to the JSON property snapshotDefinition

Returns:



9531
9532
9533
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9531

def snapshot_definition
  @snapshot_definition
end

#streaming_buffer ⇒ Google::Apis::BigqueryV2::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. Corresponds to the JSON property streamingBuffer

Returns:



9538
9539
9540
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9538

def streaming_buffer
  @streaming_buffer
end

#table_constraints ⇒ Google::Apis::BigqueryV2::TableConstraints

The TableConstraints defines the primary key and foreign key. Corresponds to the JSON property tableConstraints

Returns:



9543
9544
9545
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9543

def table_constraints
  @table_constraints
end

#table_reference ⇒ Google::Apis::BigqueryV2::TableReference

Required. Reference describing the ID of this table. Corresponds to the JSON property tableReference

Returns:



9548
9549
9550
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9548

def table_reference
  @table_reference
end

#table_replication_info ⇒ Google::Apis::BigqueryV2::TableReplicationInfo

Replication info of a table created using AS REPLICA DDL like: CREATE MATERIALIZED VIEW mv1 AS REPLICA OF src_mv Corresponds to the JSON property tableReplicationInfo

Returns:



9554
9555
9556
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9554

def table_replication_info
  @table_replication_info
end

#time_partitioning ⇒ Google::Apis::BigqueryV2::TimePartitioning

If specified, configures time-based partitioning for this table. Corresponds to the JSON property timePartitioning

Returns:



9559
9560
9561
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9559

def time_partitioning
  @time_partitioning
end

#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. Corresponds to the JSON property type

Returns:

  • (String) 


9571
9572
9573
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9571

def type
  @type
end

#view ⇒ Google::Apis::BigqueryV2::ViewDefinition

Describes the definition of a logical view. Corresponds to the JSON property view

Returns:



9576
9577
9578
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9576

def view
  @view
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9583

def update!(**args)
  @biglake_configuration = args[:biglake_configuration] if args.key?(:biglake_configuration)
  @clone_definition = args[:clone_definition] if args.key?(:clone_definition)
  @clustering = args[:clustering] if args.key?(:clustering)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @default_collation = args[:default_collation] if args.key?(:default_collation)
  @default_rounding_mode = args[:default_rounding_mode] if args.key?(:default_rounding_mode)
  @description = args[:description] if args.key?(:description)
  @encryption_configuration = args[:encryption_configuration] if args.key?(:encryption_configuration)
  @etag = args[:etag] if args.key?(:etag)
  @expiration_time = args[:expiration_time] if args.key?(:expiration_time)
  @external_catalog_table_options = args[:external_catalog_table_options] if args.key?(:external_catalog_table_options)
  @external_data_configuration = args[:external_data_configuration] if args.key?(:external_data_configuration)
  @friendly_name = args[:friendly_name] if args.key?(:friendly_name)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @labels = args[:labels] if args.key?(:labels)
  @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time)
  @location = args[:location] if args.key?(:location)
  @materialized_view = args[:materialized_view] if args.key?(:materialized_view)
  @materialized_view_status = args[:materialized_view_status] if args.key?(:materialized_view_status)
  @max_staleness = args[:max_staleness] if args.key?(:max_staleness)
  @model = args[:model] if args.key?(:model)
  @num_active_logical_bytes = args[:num_active_logical_bytes] if args.key?(:num_active_logical_bytes)
  @num_active_physical_bytes = args[:num_active_physical_bytes] if args.key?(:num_active_physical_bytes)
  @num_bytes = args[:num_bytes] if args.key?(:num_bytes)
  @num_current_physical_bytes = args[:num_current_physical_bytes] if args.key?(:num_current_physical_bytes)
  @num_long_term_bytes = args[:num_long_term_bytes] if args.key?(:num_long_term_bytes)
  @num_long_term_logical_bytes = args[:num_long_term_logical_bytes] if args.key?(:num_long_term_logical_bytes)
  @num_long_term_physical_bytes = args[:num_long_term_physical_bytes] if args.key?(:num_long_term_physical_bytes)
  @num_partitions = args[:num_partitions] if args.key?(:num_partitions)
  @num_physical_bytes = args[:num_physical_bytes] if args.key?(:num_physical_bytes)
  @num_rows = args[:num_rows] if args.key?(:num_rows)
  @num_time_travel_physical_bytes = args[:num_time_travel_physical_bytes] if args.key?(:num_time_travel_physical_bytes)
  @num_total_logical_bytes = args[:num_total_logical_bytes] if args.key?(:num_total_logical_bytes)
  @num_total_physical_bytes = args[:num_total_physical_bytes] if args.key?(:num_total_physical_bytes)
  @partition_definition = args[:partition_definition] if args.key?(:partition_definition)
  @range_partitioning = args[:range_partitioning] if args.key?(:range_partitioning)
  @replicas = args[:replicas] if args.key?(:replicas)
  @require_partition_filter = args[:require_partition_filter] if args.key?(:require_partition_filter)
  @resource_tags = args[:resource_tags] if args.key?(:resource_tags)
  @restrictions = args[:restrictions] if args.key?(:restrictions)
  @schema = args[:schema] if args.key?(:schema)
  @self_link = args[:self_link] if args.key?(:self_link)
  @snapshot_definition = args[:snapshot_definition] if args.key?(:snapshot_definition)
  @streaming_buffer = args[:streaming_buffer] if args.key?(:streaming_buffer)
  @table_constraints = args[:table_constraints] if args.key?(:table_constraints)
  @table_reference = args[:table_reference] if args.key?(:table_reference)
  @table_replication_info = args[:table_replication_info] if args.key?(:table_replication_info)
  @time_partitioning = args[:time_partitioning] if args.key?(:time_partitioning)
  @type = args[:type] if args.key?(:type)
  @view = args[:view] if args.key?(:view)
end