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



2825
2826
2827
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2825

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) 


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

def creation_time
  @creation_time
end

#description ⇒ String

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

Returns:

  • (String) 


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

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:



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

def encryption_configuration
  @encryption_configuration
end

#etag ⇒ String

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

Returns:

  • (String) 


2712
2713
2714
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2712

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) 


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

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:



2728
2729
2730
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2728

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) 


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

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) 


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

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


2743
2744
2745
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2743

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


2753
2754
2755
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2753

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) 


2759
2760
2761
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2759

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) 


2765
2766
2767
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2765

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) 


2771
2772
2773
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2771

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) 


2777
2778
2779
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2777

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) 


2783
2784
2785
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2783

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:



2788
2789
2790
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2788

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) 


2793
2794
2795
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2793

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:



2800
2801
2802
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2800

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:



2805
2806
2807
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2805

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:



2810
2811
2812
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2810

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) 


2818
2819
2820
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2818

def type
  @type
end

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

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

Returns:



2823
2824
2825
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2823

def view
  @view
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2830

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