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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Table

Returns a new instance of Table



2740
2741
2742
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2740

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

Instance Attribute Details

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


2614
2615
2616
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2614

def creation_time
  @creation_time
end

#description ⇒ String

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

Returns:

  • (String) 


2619
2620
2621
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2619

def description
  @description
end

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

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

Returns:



2624
2625
2626
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2624

def encryption_configuration
  @encryption_configuration
end

#etag ⇒ String

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

Returns:

  • (String) 


2629
2630
2631
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2629

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

Returns:

  • (Fixnum) 


2636
2637
2638
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2636

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:



2643
2644
2645
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2643

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) 


2648
2649
2650
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2648

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) 


2653
2654
2655
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2653

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


2658
2659
2660
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2658

def kind
  @kind
end

#labels ⇒ Hash<String,String>

[Experimental] 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>) 


2668
2669
2670
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2668

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) 


2674
2675
2676
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2674

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) 


2680
2681
2682
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2680

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


2686
2687
2688
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2686

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) 


2692
2693
2694
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2692

def num_long_term_bytes
  @num_long_term_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) 


2698
2699
2700
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2698

def num_rows
  @num_rows
end

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

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

Returns:



2703
2704
2705
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2703

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) 


2708
2709
2710
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2708

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



2715
2716
2717
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2715

def streaming_buffer
  @streaming_buffer
end

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

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

Returns:



2720
2721
2722
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2720

def table_reference
  @table_reference
end

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

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

Returns:



2725
2726
2727
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2725

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. The default value is TABLE. Corresponds to the JSON property type

Returns:

  • (String) 


2733
2734
2735
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2733

def type
  @type
end

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

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

Returns:



2738
2739
2740
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2738

def view
  @view
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2745

def update!(**args)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @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)
  @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_rows = args[:num_rows] if args.key?(:num_rows)
  @schema = args[:schema] if args.key?(:schema)
  @self_link = args[:self_link] if args.key?(:self_link)
  @streaming_buffer = args[:streaming_buffer] if args.key?(:streaming_buffer)
  @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