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



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

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) 


2527
2528
2529
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2527

def creation_time
  @creation_time
end

#description ⇒ String

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

Returns:

  • (String) 


2532
2533
2534
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2532

def description
  @description
end

#etag ⇒ String

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

Returns:

  • (String) 


2537
2538
2539
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2537

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) 


2544
2545
2546
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2544

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:



2551
2552
2553
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2551

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) 


2556
2557
2558
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2556

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) 


2561
2562
2563
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2561

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


2566
2567
2568
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2566

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


2576
2577
2578
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2576

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) 


2582
2583
2584
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2582

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) 


2588
2589
2590
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2588

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) 


2594
2595
2596
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2594

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) 


2600
2601
2602
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2600

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) 


2606
2607
2608
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2606

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:



2611
2612
2613
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2611

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) 


2616
2617
2618
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2616

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:



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

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:



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

def table_reference
  @table_reference
end

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

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

Returns:



2633
2634
2635
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2633

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) 


2641
2642
2643
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2641

def type
  @type
end

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

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

Returns:



2646
2647
2648
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2646

def view
  @view
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2653

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