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.



7795
7796
7797
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7795

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

Instance Attribute Details

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

[Optional] Specifies the configuration of a BigLake managed table. Corresponds to the JSON property biglakeConfiguration

Returns:



7537
7538
7539
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7537

def biglake_configuration
  @biglake_configuration
end

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

[Output-only] Clone definition. Corresponds to the JSON property cloneDefinition

Returns:



7542
7543
7544
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7542

def clone_definition
  @clone_definition
end

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

[Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered. Corresponds to the JSON property clustering

Returns:



7549
7550
7551
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7549

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) 


7555
7556
7557
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7555

def creation_time
  @creation_time
end

#default_collation ⇒ String

[Output-only] The default collation of the table. Corresponds to the JSON property defaultCollation

Returns:

  • (String) 


7560
7561
7562
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7560

def default_collation
  @default_collation
end

#default_rounding_mode ⇒ String

[Output-only] The default rounding mode of the table. Corresponds to the JSON property defaultRoundingMode

Returns:

  • (String) 


7565
7566
7567
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7565

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) 


7570
7571
7572
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7570

def description
  @description
end

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

Custom encryption configuration (e.g., Cloud KMS keys). Corresponds to the JSON property encryptionConfiguration

Returns:



7575
7576
7577
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7575

def encryption_configuration
  @encryption_configuration
end

#etag ⇒ String

[Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change. Corresponds to the JSON property etag

Returns:

  • (String) 


7583
7584
7585
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7583

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) 


7592
7593
7594
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7592

def expiration_time
  @expiration_time
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:



7599
7600
7601
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7599

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) 


7604
7605
7606
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7604

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) 


7609
7610
7611
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7609

def id
  @id
end

#kind ⇒ String

[Output-only] The type of the resource. Corresponds to the JSON property kind

Returns:

  • (String) 


7614
7615
7616
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7614

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>) 


7623
7624
7625
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7623

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) 


7629
7630
7631
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7629

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) 


7635
7636
7637
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7635

def location
  @location
end

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

[Optional] Materialized view definition. Corresponds to the JSON property materializedView

Returns:



7640
7641
7642
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7640

def materialized_view
  @materialized_view
end

#max_staleness ⇒ String

[Optional] Max staleness of data that could be returned when table or materialized view is queried (formatted as Google SQL Interval type). Corresponds to the JSON property maxStaleness NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


7647
7648
7649
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7647

def max_staleness
  @max_staleness
end

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

[Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries. Corresponds to the JSON property model

Returns:



7654
7655
7656
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7654

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) 


7659
7660
7661
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7659

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) 


7665
7666
7667
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7665

def num_active_physical_bytes
  @num_active_physical_bytes
end

#num_bytes ⇒ Fixnum

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

Returns:

  • (Fixnum) 


7671
7672
7673
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7671

def num_bytes
  @num_bytes
end

#num_long_term_bytes ⇒ Fixnum

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

Returns:

  • (Fixnum) 


7677
7678
7679
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7677

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) 


7682
7683
7684
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7682

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) 


7688
7689
7690
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7688

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) 


7695
7696
7697
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7695

def num_partitions
  @num_partitions
end

#num_physical_bytes ⇒ Fixnum

[Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel. Corresponds to the JSON property numPhysicalBytes

Returns:

  • (Fixnum) 


7702
7703
7704
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7702

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) 


7708
7709
7710
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7708

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) 


7715
7716
7717
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7715

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) 


7720
7721
7722
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7720

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) 


7727
7728
7729
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7727

def num_total_physical_bytes
  @num_total_physical_bytes
end

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

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. Corresponds to the JSON property rangePartitioning

Returns:



7733
7734
7735
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7733

def range_partitioning
  @range_partitioning
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) 


7739
7740
7741
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7739

def require_partition_filter
  @require_partition_filter
end

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

[Optional] Describes the schema of this table. Corresponds to the JSON property schema

Returns:



7745
7746
7747
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7745

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) 


7750
7751
7752
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7750

def self_link
  @self_link
end

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

[Output-only] Snapshot definition. Corresponds to the JSON property snapshotDefinition

Returns:



7755
7756
7757
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7755

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:



7762
7763
7764
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7762

def streaming_buffer
  @streaming_buffer
end

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

[Optional] The table constraints on the table. Corresponds to the JSON property tableConstraints

Returns:



7767
7768
7769
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7767

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:



7772
7773
7774
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7772

def table_reference
  @table_reference
end

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

Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. Corresponds to the JSON property timePartitioning

Returns:



7778
7779
7780
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7778

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. SNAPSHOT: An immutable, read-only table that is a copy of another table. [ TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE. Corresponds to the JSON property type

Returns:

  • (String) 


7788
7789
7790
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7788

def type
  @type
end

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

[Optional] The view definition. Corresponds to the JSON property view

Returns:



7793
7794
7795
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7793

def view
  @view
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 7800

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_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)
  @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_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)
  @range_partitioning = args[:range_partitioning] if args.key?(:range_partitioning)
  @require_partition_filter = args[:require_partition_filter] if args.key?(:require_partition_filter)
  @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)
  @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