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



3285
3286
3287
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3285

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

Instance Attribute Details

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

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



3121
3122
3123
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3121

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) 


3127
3128
3129
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3127

def creation_time
  @creation_time
end

#description ⇒ String

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

Returns:

  • (String) 


3132
3133
3134
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3132

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:



3137
3138
3139
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3137

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) 


3145
3146
3147
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3145

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) 


3154
3155
3156
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3154

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:



3161
3162
3163
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3161

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) 


3166
3167
3168
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3166

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) 


3171
3172
3173
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3171

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


3176
3177
3178
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3176

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


3185
3186
3187
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3185

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) 


3191
3192
3193
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3191

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) 


3197
3198
3199
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3197

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



3204
3205
3206
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3204

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


3210
3211
3212
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3210

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) 


3216
3217
3218
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3216

def num_long_term_bytes
  @num_long_term_bytes
end

#num_physical_bytes ⇒ Fixnum

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


3223
3224
3225
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3223

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) 


3229
3230
3231
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3229

def num_rows
  @num_rows
end

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

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

Returns:



3235
3236
3237
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3235

def range_partitioning
  @range_partitioning
end

#require_partition_filter ⇒ Boolean Also known as: require_partition_filter?

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


3241
3242
3243
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3241

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:



3247
3248
3249
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3247

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) 


3252
3253
3254
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3252

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:



3259
3260
3261
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3259

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:



3264
3265
3266
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3264

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:



3270
3271
3272
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3270

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) 


3278
3279
3280
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3278

def type
  @type
end

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

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

Returns:



3283
3284
3285
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3283

def view
  @view
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3290

def update!(**args)
  @clustering = args[:clustering] if args.key?(:clustering)
  @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)
  @model = args[:model] if args.key?(:model)
  @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_physical_bytes = args[:num_physical_bytes] if args.key?(:num_physical_bytes)
  @num_rows = args[:num_rows] if args.key?(:num_rows)
  @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)
  @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